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

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

Open
1 task done
fatboychummy opened this issue Dec 16, 2023 · 1 comment
Open
1 task done
Labels
documentation Improvements or additions to documentation

Comments

@fatboychummy
Copy link

fatboychummy commented Dec 16, 2023

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.
@fatboychummy fatboychummy added the documentation Improvements or additions to documentation label Dec 16, 2023
@fatboychummy
Copy link
Author

fatboychummy commented Dec 16, 2023

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

Issue has been updated

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant