Skip to content

Commit

Permalink
Fix various doc issues (#2160)
Browse files Browse the repository at this point in the history
  • Loading branch information
yngvar-antonsson authored Nov 21, 2023
1 parent 9396057 commit 1e437d5
Show file tree
Hide file tree
Showing 4 changed files with 8 additions and 3 deletions.
3 changes: 3 additions & 0 deletions cartridge/lua-api/compression.lua
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
--- Compression API.
--
-- @module cartridge.lua-api.compression
local lua_api_get_topology = require('cartridge.lua-api.get-topology')
local log = require('log')
local fiber = require('fiber')
Expand Down
2 changes: 1 addition & 1 deletion cartridge/test-helpers/server.lua
Original file line number Diff line number Diff line change
Expand Up @@ -319,7 +319,7 @@ end

--- Upload application config.
-- @tparam string|table config - table will be encoded as yaml and posted to /admin/config.
-- @param table opts - http request options
-- @tparam table opts - http request options
function Server:upload_config(config, opts)
checks('table', 'string|table', 'table|nil')
if type(config) == 'table' then
Expand Down
2 changes: 1 addition & 1 deletion cartridge/user-defined-role.lua
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
-- When absent, module name is used instead.
-- @tfield string role_name

--- Hidden role flag. aren't listed in
--- Hidden role flag. Aren't listed in
-- `cartridge.admin_get_replicasets().roles` and therefore in WebUI.
-- Hidden roled are supposed to be a dependency for another role.
-- @tfield boolean hidden
Expand Down
4 changes: 3 additions & 1 deletion rst/cartridge_admin.rst
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ Then :ref:`start the instances <cartridge-run>`, for example using
.. important::

``cartridge-cli`` is deprecated in favor of the :ref:`tt CLI utility <tt-cli>`.
``cartridge-cli`` is deprecated in favor of the :ref:`tt CLI utility <tt-cli>`.
This guide uses ``cartridge-cli`` as a native tool for Cartridge applications
development. However, we encourage you to switch to ``tt`` in order to simplify
the migration to Tarantool 3.0 and newer versions.
Expand Down Expand Up @@ -1304,6 +1304,8 @@ Cartridge displays cluster and instances issues in WebUI:
* Custom roles can announce more issues with their own level, topic
and message. See `custom-role.get_issues`.

.. _cartridge-compression-suggestions:

+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
Compression suggestions (Enterprise only)
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
Expand Down

0 comments on commit 1e437d5

Please sign in to comment.