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

Remove operator_area note from godoc overview #4603

Merged
merged 1 commit into from
Aug 28, 2018
Merged

Conversation

freddygv
Copy link
Contributor

@freddygv freddygv commented Aug 28, 2018

Currently the following note about operator areas shows up as the godoc synopsys for Consul:

The /​v1/​operator/​area endpoints are available only in Consul Enterprise and interact with its network area subsystem.

This is because it is the only comment above the api package declaration.

This PR moves the comment below package api since the note applies to the whole file but should not be pulled into godoc.

Copy link
Member

@mkeeler mkeeler left a comment

Choose a reason for hiding this comment

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

Good catch

@freddygv freddygv merged commit 4c5758d into master Aug 28, 2018
@freddygv freddygv deleted the godoc-overview-fix branch August 28, 2018 20:02
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.

2 participants