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

Make sure the docs use tuple field accesses #3235

Closed
cphyc opened this issue Apr 29, 2021 · 7 comments · Fixed by #3970
Closed

Make sure the docs use tuple field accesses #3235

cphyc opened this issue Apr 29, 2021 · 7 comments · Fixed by #3970
Labels
docs new contributor friendly Good for new contributors! release critical Highest priority (in a milestone)
Milestone

Comments

@cphyc
Copy link
Member

cphyc commented Apr 29, 2021

Following #3101 and #3194, ambiguous field accesses have been deprecated. We however have still many examples in the doc which use the old ambiguous syntax.

We should (gradually) update the doc to make sure no field accesses are ambiguous.

@cphyc cphyc added this to the 4.1 milestone Apr 29, 2021
@cphyc cphyc added docs new contributor friendly Good for new contributors! labels Apr 29, 2021
@neutrinoceros
Copy link
Member

Is there a trivial way to make these actual failures as a way to catch them systematically in CI so we can fix them iteratively ?

@cphyc
Copy link
Member Author

cphyc commented May 1, 2021 via email

@chummels chummels added the yt-4.0 feature targeted for the yt-4.0 release label May 21, 2021
@chummels
Copy link
Member

I am trying to partially address this in #3284

@neutrinoceros
Copy link
Member

How much progress do you think you've accomplished in that PR @chummels ?

@chummels
Copy link
Member

I think I got rid of all the non-tuple field accesses in the cookbook with that PR. I'll continue to work on the docs, but I'm open to others helping.

@neutrinoceros
Copy link
Member

neutrinoceros commented Jul 1, 2021

@chummels @cphyc , I know you've both made large contributions to the docs regarding this lately. Do you think we can close this ?

@neutrinoceros neutrinoceros removed the yt-4.0 feature targeted for the yt-4.0 release label Jul 7, 2021
@neutrinoceros neutrinoceros changed the title Make sure the docs use non-tuple field accesses Make sure the docs use tuple field accesses May 22, 2022
@neutrinoceros neutrinoceros added the release critical Highest priority (in a milestone) label May 22, 2022
@neutrinoceros
Copy link
Member

In #3970 I turned warnings into errors and got... zero (!) new error in the docs build. I think it's safe to close this now.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs new contributor friendly Good for new contributors! release critical Highest priority (in a milestone)
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants