Collections: Convert docs to Markdown and use Args/Returns syntax - #5716
Open
Shaurya2k06 wants to merge 4 commits into
Open
Collections: Convert docs to Markdown and use Args/Returns syntax#5716Shaurya2k06 wants to merge 4 commits into
Shaurya2k06 wants to merge 4 commits into
Conversation
Take Collections library documentation to Markdown and document arguments and return values explicitly. Related to robotframework#5709. Signed-off-by: shaurya2k06 <shaurya2k06@gmail.com>
Signed-off-by: shaurya2k06 <shaurya2k06@gmail.com>
Align examples, Args formatting, and result tables with the gold-standard style from merged library doc PRs (DateTime/BuiltIn/String). Related to robotframework#5709. Signed-off-by: shaurya2k06 <shaurya2k06@gmail.com>
Keep robotframework blocks valid after docstring dedent, document `list` instead of `list_`, and stop splitting keyword links across lines. Signed-off-by: shaurya2k06 <shaurya2k06@gmail.com>
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
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.
What
Why
Collections-only part of #5709.
Testing
py_compileon Collections.pyMARKDOWNformat; examples include*** Test Cases ***headers; result tables kept as comments; no blank lines after Args/Returns/Raises