Fix cluster and cbuilder module doc formatting #408
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This patch fixes a few errors in cluster module documentation: * The module is now classified as a class module instead of a regular module. * Added missing `--` denoting Lua comments in the usage section. * Changed abstract `exp_err` in `cluster.startup_error` to a specific error.
This patch fixes a few errors in cbuilder module documentation by adding missing `--` denoting Lua comments in the usage section.
|
The problems could be observed here: |
Totktonada
reviewed
Dec 24, 2024
Comment on lines
+16
to
+31
| -- -- 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") |
There was a problem hiding this comment.
Can't it be just a prose text? IOW, can we break the @usage section or move it upward?
There was a problem hiding this comment.
Or eliminate usage of the @usage section and just mark code blocks my myself?
Totktonada
reviewed
Dec 24, 2024
Comment on lines
+20
to
+21
| -- -- By default, all instances are added to replicaset-001 in group-001, | ||
| -- -- but it's possible to select a different replicaset and/or group: |
There was a problem hiding this comment.
The same question regarding this text.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This patchset fixes a few problems in cbuilder and cluster module documentation formatting.
The first patch fixes a few errors in cluster module documentation:
--denoting Lua comments in the usage section.exp_errincluster.startup_errorto a specific error.The second patch fixes a few errors in cbuilder module documentation by adding missing
--denoting Lua comments in the usage section.