docs: Update and lint all docstrings#140
Merged
tmac1973 merged 5 commits intoJan 8, 2024
mainlacework/python-sdk:mainfrom
tmacdonald/GROW-2623/update-docstringslacework/python-sdk:tmacdonald/GROW-2623/update-docstringsCopy head branch name to clipboard
Merged
docs: Update and lint all docstrings#140tmac1973 merged 5 commits intomainlacework/python-sdk:mainfrom tmacdonald/GROW-2623/update-docstringslacework/python-sdk:tmacdonald/GROW-2623/update-docstringsCopy head branch name to clipboard
tmac1973 merged 5 commits into
mainlacework/python-sdk:mainfrom
tmacdonald/GROW-2623/update-docstringslacework/python-sdk:tmacdonald/GROW-2623/update-docstringsCopy head branch name to clipboard
Conversation
added 4 commits
January 2, 2024 16:26
Incremental work to reformat, rewrite, and correct docstrings for consumption by Sphinx autodoc Signed-off-by: Timothy MacDonald <tim.macdonald@lacework.net>
Signed-off-by: Timothy MacDonald <tim.macdonald@lacework.net>
Signed-off-by: Timothy MacDonald <tim.macdonald@lacework.net>
Signed-off-by: Timothy MacDonald <tim.macdonald@lacework.net>
jon-stewart
suggested changes
Jan 8, 2024
Contributor
jon-stewart
left a comment
There was a problem hiding this comment.
Great improvements, but I have a few questions.
Signed-off-by: Timothy MacDonald <tim.macdonald@lacework.net>
jon-stewart
approved these changes
Jan 8, 2024
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
2 participants
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.
Summary:
All docstrings are now updated to google docstring format and pass linting with Ruff.
Testing:
Linting and all tests passed.
If you want to see the results and not just the source run "poetry run poe docs" to generate the documentation and open the "docs/html/index.html" file.
Issue:
https://lacework.atlassian.net/browse/GROW-2623