Skip to content
New issue

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

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

Already on GitHub? Sign in to your account

1.8.2 breaks empty classes with multiline comments #299

Closed
tannewt opened this issue Jul 27, 2021 · 2 comments
Closed

1.8.2 breaks empty classes with multiline comments #299

tannewt opened this issue Jul 27, 2021 · 2 comments

Comments

@tannewt
Copy link

tannewt commented Jul 27, 2021

Hi hi, thanks for the improvements to autoapi! It looks like 1.8.2 broke our doc build: https://github.com/adafruit/circuitpython/runs/3167416491

The cause looks to be this input stub:

class RoleError(BluetoothError):
    """Raised when a resource is used as the mismatched role.

    For example, if a local CCCD is attempted to be set but they can
    only be set when remote."""

    ...

The generated rst is:

.. py:exception:: RoleError

   Bases: :py:obj:`BluetoothError`

   Raised when a resource is used as the mismatched role.

       For example, if a local CCCD is attempted to be set but they can
       only be set when remote.
   Initialize self.  See help(type(self)) for accurate signature.

   Initialize self.  See help(type(self)) for accurate signature.

The error is:

/home/tannewt/repos/circuitpython/shared-bindings/_bleio/index.rst:49:Block quote ends without a blank line; unexpected unindent.

tannewt added a commit to tannewt/circuitpython that referenced this issue Jul 27, 2021
@AWhetter
Copy link
Collaborator

AWhetter commented Aug 1, 2021

Sorry about that. I've just done a release of v1.8.3 which fixed the problem. It works against circuitpython locally for me.

@jepler
Copy link
Contributor

jepler commented Aug 4, 2021

Thank you!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants