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

Configuration reference cluttered by having Local and normal class on the same page #629

Open
consideRatio opened this issue Jun 30, 2023 · 1 comment

Comments

@consideRatio
Copy link
Member

In our configuration reference, we end up with pages with two classes documented (GitHubOAuthenticator, but also LocalGitHubOAuthenticator), and skimming through it is overall a bit confusing due to it.

I'd like to avoid having documentation that puts both classes in the same page, making an in-page search find two different results for example. I'm not sure how, so I'm just describing this as an issue for now.

The issue can be seen here, and here is a gif about it as well.

oauth-duplicated-for-local

@consideRatio consideRatio changed the title Remove configuration reference of Local...OAuthenticator classes? Configuration reference cluttered by having Local and normal class on the same page Jun 30, 2023
@minrk
Copy link
Member

minrk commented Jun 30, 2023

I think you should be able to toggle-off inherited members, so it should only document what's new in the class. Or opt-in to specific members.

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

No branches or pull requests

2 participants