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

Standardize "experimental" warnings across all packages #3605

Closed
easwars opened this issue May 6, 2020 · 2 comments · Fixed by #3917
Closed

Standardize "experimental" warnings across all packages #3605

easwars opened this issue May 6, 2020 · 2 comments · Fixed by #3917
Assignees

Comments

@easwars
Copy link
Contributor

easwars commented May 6, 2020

We have experimental warnings sprinkled all over the repo.

One option to standardize is to use Godoc's support for inline section headings.

Adding something like this would make them stand out in our godocs and will be something that we can enforce when new experimental APIs are added.

//
// Experimental
//
// Notice: this function/type/package is experimental and may be removed in a
// later release.

https://golang.org/pkg/go/doc/#ToHTML talks about what constitutes a heading:

Each span of unindented non-blank lines is converted into a single paragraph. 
There is one exception to the rule: a span that consists of a single line, is
followed by another paragraph span, begins with a capital letter, and contains
no punctuation other than parentheses and commas is formatted as a heading.
@dfawley dfawley changed the title Standardize experimental warnings across all packages Standardize "experimental" warnings across all packages May 7, 2020
@gauravgahlot
Copy link
Contributor

gauravgahlot commented Aug 24, 2020

Hey @easwars @dfawley
I would like to work on the issue unless someone else has already started.

@menghanl
Copy link
Contributor

@gauravgahlot Thanks and go ahead! I don't think anyone is working on this.

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

Successfully merging a pull request may close this issue.

4 participants