Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove colon (':') from keywords such as "Parameters" and "Remarks" in comments #1991

Open
kexugit opened this issue Mar 27, 2023 · 0 comments
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.

Comments

@kexugit
Copy link

kexugit commented Mar 27, 2023

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

  1. Source code:
  2. 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

@kexugit kexugit added 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. labels Mar 27, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
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.
Projects
None yet
Development

No branches or pull requests

1 participant