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

x/pkgsite: Something is wrong with formatting #55888

Closed
pjebs opened this issue Sep 27, 2022 · 4 comments
Closed

x/pkgsite: Something is wrong with formatting #55888

pjebs opened this issue Sep 27, 2022 · 4 comments

Comments

@pjebs
Copy link
Contributor

pjebs commented Sep 27, 2022

Consider this package documentation: https://pkg.go.dev/github.com/joho/godotenv#Load

This is the code:

// Load will read your env file(s) and load them into ENV for this process.
//
// Call this function as close as possible to the start of your program (ideally in main)
//
// If you call Load without any args it will default to loading .env in the current path
//
// You can otherwise tell it which files to load (there can be more than one) like
//
//		godotenv.Load("fileone", "filetwo")
//
// It's important to note that it WILL NOT OVERRIDE an env variable that already exists - consider the .env file to set dev vars or sensible defaults
func Load(filenames ...string) (err error) {
	filenames = filenamesOrDefault(filenames)

	for _, filename := range filenames {
		err = loadFile(filename, false)
		if err != nil {
			return // return early on a spazout
		}
	}
	return
}

image

@pjebs pjebs added the pkgsite label Sep 27, 2022
@gopherbot gopherbot added this to the Unreleased milestone Sep 27, 2022
@pjebs
Copy link
Contributor Author

pjebs commented Sep 27, 2022

"If you call Load without any args it will default to loading .env in the current path" appears under the function signature and also in bold elsewhere.

@mvdan
Copy link
Member

mvdan commented Sep 27, 2022

See https://tip.golang.org/doc/comment#headings. Add punctuation (a terminating period) to your sentence so that it does not get interpreted as a heading.

@mvdan mvdan closed this as not planned Won't fix, can't repro, duplicate, stale Sep 27, 2022
@pjebs
Copy link
Contributor Author

pjebs commented Sep 28, 2022

@joho

joho added a commit to joho/godotenv that referenced this issue Oct 30, 2022
Fixes issue reported over at golang/go#55888
@joho
Copy link

joho commented Oct 30, 2022

Fixing in joho/godotenv#197

@pjebs as your comment was just my name it took me quite a while to look into what this actually was, and then a bit longer to care.

In future when summoning maintainers you might want to add a bit of context. It felt like you were clicking your fingers at me like some service staff you don't respect.

joho added a commit to joho/godotenv that referenced this issue Oct 30, 2022
@golang golang locked and limited conversation to collaborators Oct 30, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

4 participants