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

Fix indentation for skip_row docstring #1743

Merged
merged 2 commits into from
Feb 1, 2024

Conversation

ulliholtgrave
Copy link
Contributor

Without the newline before the code block intersphinx isn't able to parse the docstring. I also adjusted the indentation of the block and propose to use the python environment for the code block.

Problem

Intersphinx isn't able to parse the docstring for skip_row which is results in failing documentation builds.
Related issue: #1742

Solution

I added a newline before the code block and optionally adjusted the indentation and code environment of the block.

@matthewhegarty
Copy link
Contributor

Thanks for submitting. Feel free to add your name to AUTHORS and an update to CHANGELOG.rst would be appreciated.

Copy link
Contributor

@matthewhegarty matthewhegarty left a comment

Choose a reason for hiding this comment

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

One minor comment re line length

import_export/resources.py Outdated Show resolved Hide resolved
@matthewhegarty matthewhegarty linked an issue Jan 20, 2024 that may be closed by this pull request
@coveralls
Copy link

coveralls commented Jan 20, 2024

Coverage Status

coverage: 100.0%. remained the same
when pulling bcadc19 on ulliholtgrave:patch-1
into 43423b6 on django-import-export:main.

@ulliholtgrave
Copy link
Contributor Author

@matthewhegarty Thanks for the quick response. I think I applied the changes for the check. I also found some more indentation issues that intersphinx wasn't happy about. If you run your setup on --nitpick mode this also breaks.

@ulliholtgrave
Copy link
Contributor Author

I already saw the failed test. Will look into it :)

@matthewhegarty
Copy link
Contributor

Thanks. I couldn't run with nitpicky - it didn't work for me, even when I installed the dev version of Sphinx. Please could you raise a new issue which shows how to repeat the break with nitpicky?

@matthewhegarty
Copy link
Contributor

Hi - any chance you could look into this so I can get the fix into the next release.
Many thanks

@ulliholtgrave
Copy link
Contributor Author

Sorry for keep you waiting. I found one more issue with the internal linking that I wasn't really able to solve for now (very strange rabbit hole). I'll see if I can find something for it, but I should have something by the middle of next week at the latest. Sorry again for the delay.

@matthewhegarty
Copy link
Contributor

np - thanks for taking this on, much appreciated.

Without the newline before the code block intersphinx isn't able to parse the docstring. I also adjusted the indentation of the block and propose to use the python environment for the code block.
@matthewhegarty
Copy link
Contributor

Thank you - will merge

@matthewhegarty matthewhegarty merged commit 7683e92 into django-import-export:main Feb 1, 2024
13 checks passed
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.

Wrong indent in skip_row code block breaks intersphinx build
3 participants