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

Reference documentation for types is a bit odd #120

Open
ethomson opened this issue Dec 11, 2024 · 0 comments
Open

Reference documentation for types is a bit odd #120

ethomson opened this issue Dec 11, 2024 · 0 comments

Comments

@ethomson
Copy link
Member

There are a few examples where we expose the type details in sys but also have it opaque in the regular public docs. For example, git_credential_username.

In these cases, we don't provide any information about the type in the standard credential docs, only in sys. We should do better.

I would expect to see something here: https://libgit2.org/docs/reference/main/credential/index.html

Instead, I only see it here: https://libgit2.org/docs/reference/main/sys/credential/index.html

When we fix this, we need to update the redirects in libgit2.org/libgit2/index.html to account for it

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

No branches or pull requests

1 participant