-
-
Notifications
You must be signed in to change notification settings - Fork 51
Closed
Labels
featureNew feature or requestNew feature or requestinsidersCandidate for InsidersCandidate for Insiders
Description
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.
samuelcolvin
Metadata
Metadata
Assignees
Labels
featureNew feature or requestNew feature or requestinsidersCandidate for InsidersCandidate for Insiders