azure-functions-python-worker
azure-functions-python-worker copied to clipboard
[BUG] Remove colon (':') from "Returns" keywords in comments
Investigative information
Please provide the following:
- Timestamp: 3/24/2023
- Function App name:
- Function name(s) (as appropriate):
- Core Tools version:
Repro steps
- Go to https://learn.microsoft.com/en-us/python/api/azure-functions/azure.functions.servicebus.servicebusmessage?branch=live&view=azure-python#azure-functions-servicebus-servicebusmessage-metadata
- Notice that "Returns:" for the attribute "metadata" is rendered as H1 header, which is a violation of content validation rules for Learn.microsoft.com.
Expected behavior
"Returns:" should not be rendered as H1 header.
Actual behavior
"Returns:" is rendered as H1 header.
Known workarounds
According to the official documentation of numpy docstring, there shouldn't be a colon ( : ) after keyword "Returns". E.g., https://www.sphinx-doc.org/en/master/usage/extensions/example_numpy.html.
Contents of the requirements.txt file:
Provide the requirements.txt file to help us find out module related issues.
Related information
- Links to source: https://dev.azure.com/ceapex/Engineering/_workitems/edit/793397
- Bindings used
Tracking this in this issue: Azure Functions Reference Documentation is out of date for azure.functions · Issue #59 · Azure/azure-functions-pyfx-planning (github.com)
Closing in favor of: #1631