XML: Convert docs to Markdown and use Args/Returns syntax - #5719
Open
Shaurya2k06 wants to merge 4 commits into
Open
XML: Convert docs to Markdown and use Args/Returns syntax#5719Shaurya2k06 wants to merge 4 commits into
Shaurya2k06 wants to merge 4 commits into
Conversation
Take XML library documentation to Markdown and document arguments and return values explicitly. Related to robotframework#5709. Signed-off-by: shaurya2k06 <shaurya2k06@gmail.com>
There was a problem hiding this comment.
Copilot wasn't able to review any files in this pull request.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Signed-off-by: shaurya2k06 <shaurya2k06@gmail.com>
Keep real data tables as Markdown tables, fix examples for highlighting, and align Args/links with merged library doc style. Related to robotframework#5709. Signed-off-by: shaurya2k06 <shaurya2k06@gmail.com>
Unindented table rows prevented docstring dedent, and keyword examples had invalid fence tags that libdoc could not highlight. 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
XML-only part of #5709.
Testing
py_compileon XML.pyMARKDOWN); predicate/wildcard tables render as HTML tables