Skip to content

Fix numbered list in docstring#636

Merged
ascillitoe merged 1 commit intoSeldonIO:masterfrom
ascillitoe:fix/optional_deps_docstring
Sep 27, 2022
Merged

Fix numbered list in docstring#636
ascillitoe merged 1 commit intoSeldonIO:masterfrom
ascillitoe:fix/optional_deps_docstring

Conversation

@ascillitoe
Copy link
Contributor

The current docstring leads to the following sphinx error:

docstring of alibi_detect.utils.missing_optional_dependency.err_msg_template:3: ERROR: Unexpected indentation.

@ascillitoe ascillitoe changed the title Mix numbered list in docstring Fix numbered list in docstring Sep 27, 2022
@ascillitoe ascillitoe requested a review from mauicv September 27, 2022 13:46
Copy link
Contributor

@mauicv mauicv left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, I was wondering why this was causing an error on another PR I just submitted! LGTM!

@ascillitoe
Copy link
Contributor Author

Cheers @mauicv !

@ascillitoe ascillitoe merged commit 7517112 into SeldonIO:master Sep 27, 2022
@ascillitoe
Copy link
Contributor Author

P.s. @mauicv this wasn't actually the cause of the error in your PR. This error is swallowed during the sphinx build so doesn't cause a CI failure.

Your error is likely down to a problem with sphinx-autodoc-typehints 1.19.3, which should be fixed by #633.

@ascillitoe ascillitoe deleted the fix/optional_deps_docstring branch September 27, 2022 14:09
ascillitoe pushed a commit that referenced this pull request Nov 8, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants