docs: State what classes each object inherit from, with links to those classes. #101

Open
opened 2023-12-16 10:32:21 +08:00 by fatboychummy · 1 comment
fatboychummy commented 2023-12-16 10:32:21 +08:00 (Migrated from github.com)

Where?

In each class that inherits from other classes.

Possible solution

I really like the way the roblox documentation does this, it lists the methods the object itself has (like currently done), but beneath that it has dropdowns for "Inherited from <X>"

image

Others

The current way does work, but having something like this will reduce the need to click back and forth through multiple pages.

I also notice that sometimes the In addition to the A and B methods, X objects have the following methods: statement is sometimes missing base class methods (currently I am looking at Input, which is missing ChangeableObject).

Checklist

  • I am looking at the latest version of the docs.
## Where? In each class that inherits from other classes. ## Possible solution I really like the way the roblox documentation does this, it lists the methods the object itself has (like currently done), but beneath that it has dropdowns for "Inherited from \<X\>" ![image](https://github.com/Pyroxenium/Basalt/assets/39929480/8d12b795-9abf-4aaa-841a-b6b2d3c07095) ## Others The current way does work, but having something like this will reduce the need to click back and forth through multiple pages. I also notice that sometimes the `In addition to the A and B methods, X objects have the following methods:` statement is sometimes missing base class methods (currently I am looking at `Input`, which is missing `ChangeableObject`). ## Checklist - [x] I am looking at the latest version of the docs.
fatboychummy commented 2023-12-16 10:32:48 +08:00 (Migrated from github.com)

woops, I hit ctrl+enter by accident, and I guess that just auto-posts the issue. Thanks github.

Issue has been updated

~~woops, I hit ctrl+enter by accident, and I guess that just auto-posts the issue. Thanks github.~~ Issue has been updated
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: GitHub/Basalt#101
No description provided.