-
Notifications
You must be signed in to change notification settings - Fork 11
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.
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
Fix cluster and cbuilder module doc formatting #408
base: master
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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 There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Or eliminate usage of the |
||
-- | ||
-- Cluster:startup_error(config, error_message) | ||
-- | ||
-- @module luatest.cluster | ||
-- @classmod luatest.cluster | ||
|
||
local fun = require('fun') | ||
local yaml = require('yaml') | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The same question regarding this text.