docs: add docstrings for all public-facing API#16
Merged
Conversation
Signed-off-by: Max SCHMELLER <max.schmeller@tier4.jp>
Signed-off-by: Max SCHMELLER <max.schmeller@tier4.jp>
Signed-off-by: Max SCHMELLER <max.schmeller@tier4.jp>
Signed-off-by: Max SCHMELLER <max.schmeller@tier4.jp>
Signed-off-by: Max SCHMELLER <max.schmeller@tier4.jp>
Deploying sync-tooling with
|
| Latest commit: |
8c97ad7
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://1dcb9fda.sync-tooling.pages.dev |
| Branch Preview URL: | https://docs-docstrings-everywhere.sync-tooling.pages.dev |
Signed-off-by: Max SCHMELLER <max.schmeller@tier4.jp>
Signed-off-by: Max SCHMELLER <max.schmeller@tier4.jp>
|
mojomex
added a commit
that referenced
this pull request
Jan 28, 2026
* chore: update to sync_tooling_msgs that have module docs Signed-off-by: Max SCHMELLER <max.schmeller@tier4.jp> * docs: add docstrings for everything Signed-off-by: Max SCHMELLER <max.schmeller@tier4.jp> * chore: style fixes Signed-off-by: Max SCHMELLER <max.schmeller@tier4.jp> * chore: fix mkdocs warning Signed-off-by: Max SCHMELLER <max.schmeller@tier4.jp> * ci: pin tool versions to recent releases Signed-off-by: Max SCHMELLER <max.schmeller@tier4.jp> * chore: re-fix ruff errors Signed-off-by: Max SCHMELLER <max.schmeller@tier4.jp> * build: add ty pre-commit hook to spot errors early Signed-off-by: Max SCHMELLER <max.schmeller@tier4.jp> --------- Signed-off-by: Max SCHMELLER <max.schmeller@tier4.jp>
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Added Ruff rules for enforcing docstring existence and styling, added docstrings to all public-facing code. Also did some minor other formatting changes.