You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Not sure if it is just me, but I get the following warning when validating an Enum:
WARNING: [numpydoc] Validation warnings while processing docstring for 'b_asic.quantization.Quantization.ROUNDING':
GL01: Docstring text (summary) should start in the line immediately after the opening quotes (not in the same line, or leaving a blank line in between)
GL02: Closing quotes should be placed in the line after the last text in the docstring (do not close the quotes in the same line as the text, or leave a blank line between the last text and the quotes)
The code looks like:
classQuantization(Enum):
"""Quantization types."""ROUNDING=1""" Standard two's complement rounding, i.e, tie rounds towards infinity. """
Is there a more correct way to document enums or is this just something that is not completely covered in the validation?
Edit: I should mention that I have tried several different ways to format the doc-string as well.
The text was updated successfully, but these errors were encountered:
There is nothing specific to Enums in the standard, so I suppose they follow the class docstring recommendations.
Note that some of the validation checks are extra nit-picky and are not actually part of the standard - they're more just a way to help users enforce a uniform docstring format, should they choose to do so.
Not sure if it is just me, but I get the following warning when validating an Enum:
The code looks like:
Is there a more correct way to document enums or is this just something that is not completely covered in the validation?
Edit: I should mention that I have tried several different ways to format the doc-string as well.
The text was updated successfully, but these errors were encountered: