Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Docformatter breaks lines inside RST cross-references #61

Closed
DrewDevereux opened this issue Dec 18, 2020 · 2 comments
Closed

Docformatter breaks lines inside RST cross-references #61

DrewDevereux opened this issue Dec 18, 2020 · 2 comments
Labels
C: style Relates to docstring format style (e.g., Google, NumPy, Sphinx) P: bug PEP 257 violation or existing functionality that doesn't work as documented

Comments

@DrewDevereux
Copy link

Docformatter breaks lines inside RST cross-references. For example, it will format

    """
    This class contains tests of the
    `:py:class:~aaa.bbb.cccc.dddddddddd.eeeeeeeeeeeeeeeee.Fffffffffffffffffffffffff`
    class.
    """

into

    """
    This class contains tests of the `:py:class:~ska.low.mccs.controller
    .controller_device.ControllerResourceManager` class.

which is invalid RST.

@merwok
Copy link

merwok commented Dec 18, 2020

The source example was invalid too; is the bug still there with:

:py:class:`~aaa.bbb.cccc.dddddddddddddd.eeeeeeeeeeeeeeeeeeeeeeeee.FFFFFFFFFFFFFFFFFFF`

@DrewDevereux
Copy link
Author

Oops, my bad. Not a bug. Thanks for the tool by the way.

@weibullguy weibullguy added P: bug PEP 257 violation or existing functionality that doesn't work as documented C: style Relates to docstring format style (e.g., Google, NumPy, Sphinx) labels Aug 10, 2022
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
C: style Relates to docstring format style (e.g., Google, NumPy, Sphinx) P: bug PEP 257 violation or existing functionality that doesn't work as documented
Projects
None yet
Development

No branches or pull requests

3 participants