Skip to content

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

Closed

Description

@anntzer

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

Activity

  1. rcomer commented on Dec 14, 2022

    @rcomer
    Member

    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.

  2. ayushanand308 commented on Jan 5, 2023

    @ayushanand308

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

  3. rcomer commented on Jan 5, 2023

    @rcomer
    Member

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

  4. erg0dic commented on Feb 4, 2023

    @erg0dic
    Contributor

    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 ...

  5. melissawm commented on Feb 8, 2023

    @melissawm
    Member

    Is this closed by #25153?

  6. anntzer commented on Feb 8, 2023

    @anntzer
    ContributorAuthor

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

  7. QuLogic commented on Feb 21, 2023

    @QuLogic
    Member

    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.

  8. harshvardhan2707 commented on Mar 22, 2023

    @harshvardhan2707

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

  9. timhoffm commented on Mar 22, 2023

    @timhoffm
    Member

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

  10. rcomer commented on Aug 7, 2023

    @rcomer
    Member

    Closed by #26445

  11. added this to the v3.8.0 milestone on Aug 7, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

      Milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions