Skip to content

doc: factor-out repetitive documentation - #394

Merged
Totodore merged 5 commits into
mainfrom
doc-fix
Nov 5, 2024
Merged

doc: factor-out repetitive documentation#394
Totodore merged 5 commits into
mainfrom
doc-fix

Conversation

@Totodore

@TotodoreTotodore commented Nov 4, 2024

Copy link
Copy Markdown
Owner

Motivation

Currently, the documentation for all the operators is duplicated multiple times in the codebase for the different methods in Socket, ConfOperators, BroadcastOperators, and SocketIo. 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

  • Factor out the documentation for these functions into external .md files and use #[doc = include_str!("path")] to include the corresponding documentation files.
  • Enhance the documentation by adding more examples and establishing stable style guidelines (both visual and grammatical).

@TotodoreTotodore self-assigned this Nov 4, 2024
@Totodore
Totodore marked this pull request as ready for review November 5, 2024 17:27
@Totodore
Totodore merged commit 9a58244 into mainNov 5, 2024
@Totodore
Totodore deleted the doc-fix branch November 5, 2024 17:29
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant

@Totodore