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

feature: Backlinks #153

Open
pawamoy opened this issue Apr 26, 2024 · 0 comments
Open

feature: Backlinks #153

pawamoy opened this issue Apr 26, 2024 · 0 comments
Assignees
Labels
feature New feature or request fund Issue priority can be boosted insiders Candidate for Insiders

Comments

@pawamoy
Copy link
Member

pawamoy commented Apr 26, 2024

Is your feature request related to a problem? Please describe.

I'm having fun looking at matrix-nio's API, and also having trouble finding how to get the details of a room.

I resorted to searching for "room name" into the big HTML page, and ended up on this class: https://matrix-nio.readthedocs.io/en/latest/nio.html#nio.rooms.MatrixRoom, which seems to provide the info I want.

However I don't how I'm supposed to get back instances of this class (client.joined_rooms only returns a list of room ids as strings).

So I thought, "would be nice if there were links in this class docs showing me what functions/methods return instances of it". Backlinks!

Describe the solution you'd like

A way to display backlinks in the rendered docs:

  • For a class: which functions/methods return instances of it.
  • For anything: which functions/methods uses it. Not possible yet as we don't scan function bodies.
  • ?

Describe alternatives you've considered

Manual backlinks?

Additional context

This will probably need changes in Griffe.

Boost priority

  • Boost priority in our backlog through Polar.sh. Higher pledge, higher priority.
  • Minimum pledge by user/organization is $5, minimum amount for boost is $30.
  • View all issues with pledges.
  • We receive the funds once the issue is completed and confirmed by you.
  • Features with the insiders label are released to sponsors first, and tied to a funding goal.
Fund with Polar
@pawamoy pawamoy added the feature New feature or request label Apr 26, 2024
@pawamoy pawamoy self-assigned this Apr 26, 2024
@pawamoy pawamoy added the insiders Candidate for Insiders label Aug 20, 2024
@pawamoy pawamoy added the fund Issue priority can be boosted label Oct 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature New feature or request fund Issue priority can be boosted insiders Candidate for Insiders
Projects
None yet
Development

No branches or pull requests

1 participant