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

Add example usage for username #53

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion config/local.go
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import (
)

func init() {
Register(User, "local", "username", "provide a local username",
Register(User, "local", "username", "provide a local username, e.g. '-user=local,olgabot@localhost'",
Copy link
Collaborator

Choose a reason for hiding this comment

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

This isn't actually the string shown in the flag: it's shown in the help text printed by reflow config -help.

$ reflow -help
...
  -user string
    	override user from config; see reflow config -help

If you look at reflow config -help:

$ reflow config -help
...
user: local,username
	provide a local username

Which I think makes sense in context...

func(cfg Config, arg string) (Config, error) {
if !strings.Contains(arg, "@") {
return nil, errors.New("local: username must contain @")
Expand Down