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

More docs fixes #3326

Merged
merged 4 commits into from
Sep 2, 2024
Merged

More docs fixes #3326

merged 4 commits into from
Sep 2, 2024

Conversation

kurtmckee
Copy link
Contributor

@kurtmckee kurtmckee commented Jul 19, 2024

Pull Request check-list

Please make sure to review and check all of these items:

  • Do tests and lints pass with this change?
  • Do the CI tests pass with this change (enable it first in your forked repo and wait for the github action build to finish)?
  • Is the new or changed code fully tested?
  • Is a documentation update included (if this change modifies existing APIs, or introduces new ones)?
  • Is there an example added to the examples folder (if applicable)?
  • Was the change added to CHANGES file?

NOTE: these things are not required to open a PR and can be done
afterwards / while the PR is open.

Description of change

This PR resolves three classes of warnings and errors that Sphinx reports when building the documentation (recent example; click the python -m sphinx accordion to see the details):

  • "Unexpected indentation"
  • "Unexpected unindent"
  • "more than one target for cross-reference 'Redis'"

@kurtmckee
Copy link
Contributor Author

Friendly ping.

This resolves more classes of build warnings that are thrown during documentation builds (examples of remaining warnings that I'd like to resolve after this PR merges). 😀

…ings

When Sphinx runs, `TYPE_CHECKING` is not enabled,
so the differentiating sync/async `Redis` imports don't happen,
and Sphinx appears to be unable to infer which class
`"Redis"` should cross-reference.
@kurtmckee
Copy link
Contributor Author

Hello @gerzse and @vladvildanov! Please review this PR when you can. It addresses three categories of documentation build warnings.

If this merges, there will only be one documentation warning category left: "reference target not found".

docstring of redis.commands.core.BasicKeyCommands.getex:: WARNING: py:class reference target not found: datetime.datetime
docstring of redis.commands.core.HashCommands.hexpire:1: WARNING: py:class reference target not found: datetime.timedelta
docstring of redis.commands.core.HashCommands.hexpire:1: WARNING: py:class reference target not found: Returns a list which contains for each field in the request

@vladvildanov
Copy link
Collaborator

@kurtmckee Thank you for your contribution!

@vladvildanov vladvildanov self-requested a review August 22, 2024 14:02
@vladvildanov vladvildanov merged commit 77e09b7 into redis:master Sep 2, 2024
55 checks passed
@kurtmckee kurtmckee deleted the more-docs-fixes branch September 2, 2024 12:41
vladvildanov added a commit that referenced this pull request Sep 27, 2024
* Docs: Resolve 'Unexpected indentation' warnings

* Docs: Resolve 'Unexpected unindent' warnings

* Docs: Resolve "more than one target for cross-reference 'Redis'" warnings

When Sphinx runs, `TYPE_CHECKING` is not enabled,
so the differentiating sync/async `Redis` imports don't happen,
and Sphinx appears to be unable to infer which class
`"Redis"` should cross-reference.

---------

Co-authored-by: Vladyslav Vildanov <117659936+vladvildanov@users.noreply.github.com>
vladvildanov added a commit that referenced this pull request Sep 27, 2024
* Docs: Resolve 'Unexpected indentation' warnings

* Docs: Resolve 'Unexpected unindent' warnings

* Docs: Resolve "more than one target for cross-reference 'Redis'" warnings

When Sphinx runs, `TYPE_CHECKING` is not enabled,
so the differentiating sync/async `Redis` imports don't happen,
and Sphinx appears to be unable to infer which class
`"Redis"` should cross-reference.

---------

Co-authored-by: Vladyslav Vildanov <117659936+vladvildanov@users.noreply.github.com>
vladvildanov added a commit that referenced this pull request Sep 27, 2024
* Docs: Resolve 'Unexpected indentation' warnings

* Docs: Resolve 'Unexpected unindent' warnings

* Docs: Resolve "more than one target for cross-reference 'Redis'" warnings

When Sphinx runs, `TYPE_CHECKING` is not enabled,
so the differentiating sync/async `Redis` imports don't happen,
and Sphinx appears to be unable to infer which class
`"Redis"` should cross-reference.

---------

Co-authored-by: Vladyslav Vildanov <117659936+vladvildanov@users.noreply.github.com>
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