Skip to content

Use r""" if any backslashes in a docstring #75

@jorgepiloto

Description

@jorgepiloto

🐞 Problem
It looks like some docstrings include double quotes for highlighting some keywords, see:

@property                                                                   
def Angle(self) -> typing.Any:                                              
    """The computed angle. The value of the angle is in \"AngleUnit\" dimension."""
    with agmarshall.VARIANT_arg() as arg_pRetVal:                           
        agcls.evaluate_hresult(self.__dict__["_GetAngle"](byref(arg_pRetVal.COM_val)))
        return arg_pRetVal.python_val

If the word AngleUnit wants to be highlighted in the rendered documentation, it should be surrounded by double back ticks.

These files show previous issue:

src/ansys/stk/core/graphics.py:16143:9: D301 Use r""" if any backslashes in a docstring
src/ansys/stk/core/stkobjects/__init__.py:9847:5: D301 Use r""" if any backslashes in a docstring
src/ansys/stk/core/stkobjects/__init__.py:9909:5: D301 Use r""" if any backslashes in a docstring
src/ansys/stk/core/stkobjects/__init__.py:10066:5: D301 Use r""" if any backslashes in a docstring
src/ansys/stk/core/stkobjects/__init__.py:10284:5: D301 Use r""" if any backslashes in a docstring
src/ansys/stk/core/stkobjects/__init__.py:11159:9: D301 Use r""" if any backslashes in a docstring
src/ansys/stk/core/stkobjects/__init__.py:16021:9: D301 Use r""" if any backslashes in a docstring
src/ansys/stk/core/stkobjects/__init__.py:27896:9: D301 Use r""" if any backslashes in a docstring
src/ansys/stk/core/stkobjects/__init__.py:28150:9: D301 Use r""" if any backslashes in a docstring
src/ansys/stk/core/stkobjects/__init__.py:29367:9: D301 Use r""" if any backslashes in a docstring
src/ansys/stk/core/stkobjects/__init__.py:29807:9: D301 Use r""" if any backslashes in a docstring
src/ansys/stk/core/stkobjects/__init__.py:29814:9: D301 Use r""" if any backslashes in a docstring
src/ansys/stk/core/stkobjects/__init__.py:29821:9: D301 Use r""" if any backslashes in a docstring
src/ansys/stk/core/stkobjects/__init__.py:29849:9: D301 Use r""" if any backslashes in a docstring
src/ansys/stk/core/stkobjects/__init__.py:60618:9: D301 Use r""" if any backslashes in a docstring
src/ansys/stk/core/stkobjects/__init__.py:60626:9: D301 Use r""" if any backslashes in a docstring
src/ansys/stk/core/stkobjects/__init__.py:83896:9: D301 Use r""" if any backslashes in a docstring
src/ansys/stk/core/stkobjects/__init__.py:92534:9: D301 Use r""" if any backslashes in a docstring
src/ansys/stk/core/stkobjects/__init__.py:99017:9: D301 Use r""" if any backslashes in a docstring
src/ansys/stk/core/stkobjects/__init__.py:127066:5: D301 Use r""" if any backslashes in a docstring
src/ansys/stk/core/stkobjects/__init__.py:127090:5: D301 Use r""" if any backslashes in a docstring
src/ansys/stk/core/stkobjects/astrogator.py:10389:9: D301 Use r""" if any backslashes in a docstring
src/ansys/stk/core/stkobjects/astrogator.py:10426:9: D301 Use r""" if any backslashes in a docstring
src/ansys/stk/core/vgt.py:2611:9: D301 Use r""" if any backslashes in a docstring
src/ansys/stk/core/vgt.py:2639:9: D301 Use r""" if any backslashes in a docstring
src/ansys/stk/core/vgt.py:12236:9: D301 Use r""" if any backslashes in a docstring
src/ansys/stk/core/vgt.py:25582:9: D301 Use r""" if any backslashes in a docstring
src/ansys/stk/core/vgt.py:25589:9: D301 Use r""" if any backslashes in a docstring
src/ansys/stk/core/vgt.py:26047:9: D301 Use r""" if any backslashes in a docstring
src/ansys/stk/core/vgt.py:26102:9: D301 Use r""" if any backslashes in a docstring
src/ansys/stk/core/vgt.py:26109:9: D301 Use r""" if any backslashes in a docstring
src/ansys/stk/core/vgt.py:26170:9: D301 Use r""" if any backslashes in a docstring
src/ansys/stk/core/vgt.py:26177:9: D301 Use r""" if any backslashes in a docstring
src/ansys/stk/core/vgt.py:26257:9: D301 Use r""" if any backslashes in a docstring

Metadata

Metadata

Assignees

No one assigned

    Labels

    docsIssues related to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions