Skip to content

Fix cluster and cbuilder module doc formatting #408

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
georgiy-belyanin wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Fix cluster and cbuilder module doc formatting #408

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
91f4d30
Fix cluster module doc formatting
georgiy-belyanin Dec 24, 2024
304c576
Fix cbuilder module doc formatting
georgiy-belyanin Dec 24, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 15 additions & 16 deletions luatest/cluster.lua
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,25 +13,24 @@
-- server:exec(<...>)
-- end)
--
-- After setting up a cluster object the following methods could
-- be used to interact with it:
-- -- After setting up a cluster object the following methods
-- -- could be used to interact with it:
-- -- * :start() Startup the cluster.
-- -- * :start_instance() Startup a specific instance.
-- -- * :stop() Stop the cluster.
-- -- * :each() Execute a function on each instance.
-- -- * :size() get an amount of instances
-- -- * :drop() Drop the cluster.
-- -- * :sync() Sync the configuration and collect a new set of
-- -- instances
-- -- * :reload() Reload the configuration.
--
-- * :start() Startup the cluster.
-- * :start_instance() Startup a specific instance.
-- * :stop() Stop the cluster.
-- * :each() Execute a function on each instance.
-- * :size() get an amount of instances
-- * :drop() Drop the cluster.
-- * :sync() Sync the configuration and collect a new set of
-- instances
-- * :reload() Reload the configuration.
-- -- The module can also be used for testing failure startup
-- -- cases:
--
-- The module can also be used for testing failure startup
-- cases:
-- Cluster.startup_error(config, "something went wrong")
Comment on lines +16 to +31
Copy link
Contributor

@Totktonada Totktonada Dec 24, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can't it be just a prose text? IOW, can we break the @usage section or move it upward?

Copy link
Contributor

@Totktonada Totktonada Dec 24, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Or eliminate usage of the @usage section and just mark code blocks my myself?

--
-- Cluster:startup_error(config, error_message)
--
-- @module luatest.cluster
-- @classmod luatest.cluster

local fun = require('fun')
local yaml = require('yaml')
Expand Down