-
Notifications
You must be signed in to change notification settings - Fork 304
Closed
Labels
bugIndicates an unexpected problem or an unintended behavior.Indicates an unexpected problem or an unintended behavior.needs-triageThe issue has just been created and it has not been reviewed by the team.The issue has just been created and it has not been reviewed by the team.
Description
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
- Source code:
Parameters: - API reference document generated based on the source code: https://review.learn.microsoft.com/en-us/python/api/botbuilder-ai/botbuilder.ai.qna.utils.train_utils.trainutils?branch=sphinx6.1.3-compare&view=botbuilder-py-latest#botbuilder-ai-qna-utils-train-utils-trainutils-call-train
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
Metadata
Metadata
Assignees
Labels
bugIndicates an unexpected problem or an unintended behavior.Indicates an unexpected problem or an unintended behavior.needs-triageThe issue has just been created and it has not been reviewed by the team.The issue has just been created and it has not been reviewed by the team.