azure-functions-python-worker icon indicating copy to clipboard operation
azure-functions-python-worker copied to clipboard

[BUG] Remove colon (':') from "Returns" keywords in comments

Open kexugit opened this issue 2 years ago • 1 comments

Investigative information

Please provide the following:
  • Timestamp: 3/24/2023
  • Function App name:
  • Function name(s) (as appropriate):
  • Core Tools version:

Repro steps

  1. 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
  2. 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

kexugit avatar Mar 24 '23 18:03 kexugit

Closing in favor of: #1631

EvanR-Dev avatar Feb 05 '25 21:02 EvanR-Dev