You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
[Doc]: Delete examples made redundant by annotation tutorial rewrite (annotate_simple01, ...) #24723
#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).
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.
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 ...
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.
Activity
rcomer commentedon 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 commentedon Jan 5, 2023
@anntzer I would like to work on this. Can you assign me this issue?
rcomer commentedon Jan 5, 2023
Thanks @ayushanand308, please go ahead but we don't really assign issues.
erg0dic commentedon 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
in the corresponding locations where the examples were used in the text of the
annotations.pyfile.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 commentedon Feb 8, 2023
Is this closed by #25153?
anntzer commentedon Feb 8, 2023
Feel free to close this if you think it has been handled; I haven't really followed that PR.
QuLogic commentedon Feb 21, 2023
It seems like
annotate_simple_coord02.pywas left behind; if that should stay, it should probably be renamed without the02. Otherwise, it could also be deleted and this issue closed.harshvardhan2707 commentedon Mar 22, 2023
Has this issue been resolved and if not I would like to work on this
timhoffm commentedon Mar 22, 2023
Feel free. The only thing left to do is deleting the above file.
rcomer commentedon Aug 7, 2023
Closed by #26445