Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

Doc fix nitpick#15034

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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Merged
tacaswell merged 5 commits intomatplotlib:masterfromtacaswell:doc_fix_nitpick
Aug 12, 2019
Merged

Conversation

tacaswell
Copy link
Member

@tacaswelltacaswell commentedAug 12, 2019
edited
Loading

This replaces#15015 .

Closes#15030

tacaswelland others added2 commitsAugust 11, 2019 21:10
aka some missing references were fixed between the last build of thenitpicky-mode PR and its merge.
@tacaswelltacaswell added this to thev3.2.0 milestoneAug 12, 2019
@tacaswelltacaswell added the Release criticalFor bugs that make the library unusable (segfaults, incorrect plots, etc) and major regressions. labelAug 12, 2019
@ImportanceOfBeingErnest
Copy link
Member

ImportanceOfBeingErnest commentedAug 12, 2019
edited
Loading

I pushed the fix for the offending flake line to your fork@tacaswell (hoping that it helps more than it troubles).

In general, however, I have some problems with this nitpicky stuff.

  1. It seems noone is currently able to understand the reasons for (most of) the missing references. They might even be caused by bugs upstream. It is hence likely that they won't be fixed soon. Also, if there are upstream fixes required, they might not help because currently the sphinx version used by matplotlib is pinned.
  2. From now on, each time an edit of any of the files that contain missing references in docstrings will require to edit the line numbers, which is not only cumbersome, but clearly a burden we should not load on contributors' shoulders.
  3. The race condition that led to this trouble here will likely reoccur in the future unless all missing references have been fixed at least once.

So is anyone actually optimistic this can be solved anytime soon? If not, I would propose to disable nitpicky for now.

@alexrudy
Copy link
Contributor

@ImportanceOfBeingErnest I think you are right, but I would propose something slightly different:

The line number bit was suggested by@anntzer in the original PR. I propose we remove the warnings about unused nitpick ignores by line number – but otherwise leave nitpick turned on.

This will still prevent the addition of "new" incorrect references, but allow any existing missing references to persist. The disadvantage is that it will allow "old" missing reference ignores to persist as well.

@tacaswell
Copy link
MemberAuthor

Thanks@ImportanceOfBeingErnest definitely helps more than it hurts!

I'm going to merge this so that our docs build clean again and move discussion about this to a new issue.

@tacaswelltacaswell merged commite4dbfb5 intomatplotlib:masterAug 12, 2019
@tacaswelltacaswell deleted the doc_fix_nitpick branchAugust 12, 2019 13:22
Copy link
Contributor

@alexrudyalexrudy left a comment

Choose a reason for hiding this comment

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

This LGTM –

The double backtick issues is pervasive in matplotlib, and causes some issues in newer versions of numpydoc.

Sign up for freeto join this conversation on GitHub. Already have an account?Sign in to comment
Reviewers

@QuLogicQuLogicQuLogic left review comments

@alexrudyalexrudyalexrudy approved these changes

Assignees
No one assigned
Labels
DocumentationRelease criticalFor bugs that make the library unusable (segfaults, incorrect plots, etc) and major regressions.
Projects
None yet
Milestone
v3.2.0
Development

Successfully merging this pull request may close these issues.

Doc build broken
6 participants
@tacaswell@ImportanceOfBeingErnest@alexrudy@QuLogic@dstansby@anntzer

[8]ページ先頭

©2009-2025 Movatter.jp