Remove colon (':') from keywords such as "Parameters" and "Remarks" in comments #1991
Labels
bug
Indicates an unexpected problem or an unintended behavior.
needs-triage
The issue has just been created and it has not been reviewed by the team.
Github issues should be used for bugs and feature requests. Use Stack Overflow for general "how-to" questions.
Version
Latest
Describe the bug
Keywords such as "Parameters" and "Remarks" used in comments, if followed by colon (':'), will generate unwanted H1 headers in API reference documents.
See the proper usage in: https://www.sphinx-doc.org/en/master/usage/extensions/example_numpy.html
To Reproduce
botbuilder-python/libraries/botbuilder-ai/botbuilder/ai/qna/utils/train_utils.py
Line 20 in a7ae841
Expected behavior
Remove colon (':') after the keywords (Parameters, Remarks, Returns) in the comments so that they can be rendered properly in API reference documents
Screenshots
If applicable, add screenshots to help explain your problem.
Additional context
https://dev.azure.com/ceapex/Engineering/_workitems/edit/793397
The text was updated successfully, but these errors were encountered: