microsoft / botbuilder-python

The Microsoft Bot Framework provides what you need to build and connect intelligent bots that interact naturally wherever your users are talking, from text/sms to Skype, Slack, Office 365 mail and other popular services.
http://botframework.com
MIT License
672 stars 271 forks source link

Remove the colon (':') from keywords such as "Parameters", "Remarks" and "Returns" in comments. #2130

Closed gandiddi closed 1 day ago

gandiddi commented 4 days ago

Fixes #1991

Description

To avoid generating unwanted H1 headers in API reference documents, remove the colon (':') from keywords such as "Parameters", "Remarks" and "Returns" in comments.

See the proper usage in: https://www.sphinx-doc.org/en/master/usage/extensions/example_numpy.html