[Doc]: above vs below wording in async programming · Issue #24632 · matplotlib/matplotlib · GitHub
Skip to content

[Doc]: above vs below wording in async programming #24632

Description

@jamesbraza

Documentation Link

https://matplotlib.org/stable/users/explain/interactive_guide.html#input-hook-integration

Problem

There is a sentence:

If you want the GUI to be responsive during long running code it is necessary to periodically flush the GUI event queue as described above.

However, if you click the link, it takes you further down the page. Yes this is a docs nit, but for a half second the "above" being incorrect made me question if I'd enough coffee yet.

Suggested improvement

If you want the GUI to be responsive during long running code it is necessary to periodically flush the GUI event queue as described in the explicit event loop control section.

I think using words like "above" and "below" are brittle and likely to become stale.

Activity

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    Documentation🌱 Good first issueOpen a pull request against these issues if there are no active ones!

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions