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

contrib/apiage: Provide links to go docs for APIs #734

Closed
wants to merge 1 commit into from

Conversation

anoopcs9
Copy link
Collaborator

@anoopcs9 anoopcs9 commented Jul 8, 2022

fixes #592

Signed-off-by: Anoop C S <anoopcs@cryptolab.net>
@phlogistonjohn
Copy link
Collaborator

Did you try any of the links generated? I ask because I was under the impression that preview APIs would not show up on pkg.go.dev because there's no way to indicate to pkg.go.dev what build tags you want it to use. Therefore, it would not include anything that requires the ceph_preview build tag (see #601 ).

@ansiwen
Copy link
Collaborator

ansiwen commented Jul 11, 2022

I ask because I was under the impression that preview APIs would not show up on pkg.go.dev because there's no way to indicate to pkg.go.dev what build tags you want it to use.

That's not just your impression but a fact, easily confirmed by for example searching in the rados docs for SetLocator, which is in preview since v0.15.0.

This makes #592 a bit moot tbh, since then there will be just a few links to deprecated functions, that we don't want that people use anyway.

@anoopcs9
Copy link
Collaborator Author

I ask because I was under the impression that preview APIs would not show up on pkg.go.dev because there's no way to indicate to pkg.go.dev what build tags you want it to use.

That's not just your impression but a fact, easily confirmed by for example searching in the rados docs for SetLocator, which is in preview since v0.15.0.

Correct. I should have asked first the very same question when I noticed this issue with doc generation while making the change.

This makes #592 a bit moot tbh, since then there will be just a few links to deprecated functions, that we don't want that people use anyway.

I agree.

@anoopcs9
Copy link
Collaborator Author

Following the discussion on #592 , I am taking the PR out.

@anoopcs9 anoopcs9 closed this Jul 12, 2022
@anoopcs9 anoopcs9 deleted the api-godoc-link branch July 12, 2022 06:16
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

Successfully merging this pull request may close these issues.

apiage: add links to documentation
3 participants