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

repo-create: man page "FAQ" section not clear on use of -b (--default-branch=NAME) option #93

Open
salewski opened this issue Dec 11, 2024 · 0 comments

Comments

@salewski
Copy link
Owner

$ ads-github-repo-create --version
ads-github-repo-create 0.3.5  (built: 2022-10-26 03:00:35)

Copyright (C) 2020, 2022 Alan D. Salewski <[email protected]>
License GPLv2+: GNU GPL version 2 or later <http://gnu.org/licenses/gpl.html>.
This is free software: you are free to change and redistribute it.
There is NO WARRANTY, to the extent permitted by law.

Written by Alan D. Salewski.

The "FAQ" section of the ads-github-repo-create(1) manual page contains an entry that begins with the following:

       •   Q: I want to use a specific name for the default branch. Is
           "ads-github-repo-create" the right tool for the job?

           A: Yes, but whether or not you should use the "-b"
           ("--default-branch=NAME") option depends on the task context and
           what you are trying to achieve.

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 a README.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.

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

No branches or pull requests

1 participant