Skip to content

[Doc]: Delete examples made redundant by annotation tutorial rewrite (annotate_simple01, ...) #24723

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

Closed
anntzer opened this issue Dec 14, 2022 · 10 comments
Labels
Documentation Good first issue Open a pull request against these issues if there are no active ones! topic: annotation
Milestone

Comments

@anntzer
Copy link
Contributor

anntzer commented Dec 14, 2022

Documentation Link

No response

Problem

#23606 moved a bunch of examples (annotate_simple01, ...) into the tutorial itself. These examples are so short (and devoid of any explanatory text) that they can now be removed from the examples gallery and replaced by a redirect-from directive in the tutorial (to not break old links).

Suggested improvement

No response

@anntzer anntzer added Documentation Good first issue Open a pull request against these issues if there are no active ones! topic: annotation labels Dec 14, 2022
@rcomer
Copy link
Member

rcomer commented Dec 14, 2022

Having recently been learning about annotations, I got a bit lost in the examples and api docs. I eventually concluded that I should have started with the tutorial, so I am 👍 on anything that guides people there at the earliest opportunity.

@ayushanand308
Copy link

@anntzer I would like to work on this. Can you assign me this issue?

@rcomer
Copy link
Member

rcomer commented Jan 5, 2023

Thanks @ayushanand308, please go ahead but we don't really assign issues.

@erg0dic
Copy link
Contributor

erg0dic commented Feb 4, 2023

Hi @anntzer, I noticed that there wasn't a pull request yet for this issue so I tried tackling it. Please have a look at my pull request.

I noticed there were about 7 obvious examples in the user gallery that could easily be removed so I did just that and added a

# .. redirect-from:: /gallery/userdemo/<gallery_example>

in the corresponding locations where the examples were used in the text of the annotations.py file.

Not sure about the format for the redirect-from because I've never used sphinx? is that right? for autodoc generation. I saw the redirect-froms in a bunch of files in the header so just flagging that ...

@melissawm
Copy link
Member

Is this closed by #25153?

@anntzer
Copy link
Contributor Author

anntzer commented Feb 8, 2023

Feel free to close this if you think it has been handled; I haven't really followed that PR.

@QuLogic
Copy link
Member

QuLogic commented Feb 21, 2023

It seems like annotate_simple_coord02.py was left behind; if that should stay, it should probably be renamed without the 02. Otherwise, it could also be deleted and this issue closed.

@harshvardhan2707
Copy link

Has this issue been resolved and if not I would like to work on this

@timhoffm
Copy link
Member

Feel free. The only thing left to do is deleting the above file.

@rcomer
Copy link
Member

rcomer commented Aug 7, 2023

Closed by #26445

@rcomer rcomer closed this as completed Aug 7, 2023
@rcomer rcomer added this to the v3.8.0 milestone Aug 7, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Good first issue Open a pull request against these issues if there are no active ones! topic: annotation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

8 participants