repo-create: man page "FAQ" section not clear on use of -b (--default-branch=NAME) option #93
Labels
area:documentation
Improvements or additions to documentation
effort-est: 1 (low)
priority: 2 (soon)
severity: 6 (minor)
status:acknowledged
type:bug
Something isn't working
The "FAQ" section of the
ads-github-repo-create(1)
manual page contains an entry that begins with the following:and then goes on to try to clarify the situations in which the user may or may not want to use the
-b
(--default-branch=NAME
) option. Two examples are presented, but their differing results are less apparent than they could be; that makes it difficult for the reader to comprehend the guidance.The explanation does clearly state that the
-b
(--default-branch=NAME
) option implies the-a
(--auto-init
) option, but it should say more to spell out the implications. Specifically, it should note that the behavior will be to initialize the repository with aREADME.md
file, and that the newly created repository will already have one commit in it. With that context, the second example would make better sense, as the difference between the two behaviors would be more obvious to the reader.As it is currently written, the second example for that FAQ may appear to the casual reader to be a more cumbersome way to achieve the same thing as the first example. The second example is there to show how to achieve a truly "empty repository" -- one with zero commits in it.
The text was updated successfully, but these errors were encountered: