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

feat(docs): add namespace (formatted for docfx) #6332

Merged
merged 1 commit into from
Jun 9, 2023

Conversation

bshaffer
Copy link
Contributor

@bshaffer bshaffer commented Jun 8, 2023

This is a solution for adding namespaces in #6321, and should look something like:

@bshaffer bshaffer requested review from a team as code owners June 8, 2023 14:48
@bshaffer bshaffer added the next release PRs to be included in the next release label Jun 8, 2023
@@ -10,6 +10,7 @@ items:

This class is currently experimental and may be subject to changes.
type: class
namespace: 'Google \ Cloud \ SecretManager \ V1 \ Client'
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Based on the example from googleapis/doc-pipeline#478, I think the namespace should have the SecretManagerServiceClient (maybe in href) added at the end - do you want to exclude the current class?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like the idea visually (as long as the href is wrapping it) but in this case, since this falls directly under the header Namespace, I think it would be confusing unless there's a way to make it VERY obvious. For instance, if we greyed it out and put it in italics.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We also found that we can’t add HTML here so we are going to skip this for now (and hopefully add it later)

Copy link

@dandhlee dandhlee left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@bshaffer bshaffer merged commit 4234745 into main Jun 9, 2023
@bshaffer bshaffer deleted the add-namespace-to-docfx branch June 9, 2023 17:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
next release PRs to be included in the next release
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants