doc: factor-out repetitive documentation #394
Merged
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.
Motivation
Currently, the documentation for all the operators is duplicated multiple times in the codebase for the different methods in
Socket
,ConfOperators
,BroadcastOperators
, andSocketIo
. This duplication makes the documentation difficult to maintain, as updates must be made in every instance.I will also work on improving the documentation style by removing third-person verbs and consistently writing documentation in the imperative mood (e.g., "Get a socket ID" instead of "Gets a socket ID").
Solution
.md
files and use#[doc = include_str!("path")]
to include the corresponding documentation files.