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 file/directory placeholders #207

Conversation

EmilyGraceSeville7cf
Copy link
Contributor

@EmilyGraceSeville7cf EmilyGraceSeville7cf commented Dec 3, 2022

Use "<path/to/file>" and "<path/to/directory>" instead of not standardized variations like <file>, <dir> and <directory>.

Users should have the same the best experience on all pages.

@chrisallenlane
Copy link
Member

@EmilySeville7cfg, I would actually rather avoid using <path/to/file>.

In docopt, the placeholders (like <foo>) are names, so it's not correct to put paths here.

Alternatively, something like <infile>, <outfile>, <file-1>, <file-2>, etc, might make sense, because those are descriptive.

Please let me know if this makes sense. Thanks.

EmilyGraceSeville7cf pushed a commit to EmilyGraceSeville7cf/shell-cheatsheets that referenced this pull request Dec 17, 2022
@EmilyGraceSeville7cf
Copy link
Contributor Author

Yeah, such way of presenting paths makes sense. I've updated #194 PR according to your comment. :)

@edgester
Copy link
Contributor

@chrisallenlane , How do we resolve issue #190? What is the preferred way to do placeholders for the most common ones? For example, when the find command, would we use find <directory> ... or something else. I'm just looking to be consistent. I like what @EmilySeville7cfg is doing with cleaning up.

@EmilyGraceSeville7cf
Copy link
Contributor Author

EmilyGraceSeville7cf commented Dec 18, 2022

@edgester, I've proposed these rules for placeholders:

  • For path placeholders use <in-file>, <out-file>, or <file>. Almost the same applies to directories
    but instead of term file dir term is used.

Initially I've tried to apply TlDr page placeholder syntax here but this idea was declined so I've suggested alternatives. ;)

@EmilyGraceSeville7cf
Copy link
Contributor Author

I am closing this PR to make project maintainer pay attention for it.

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

Successfully merging this pull request may close these issues.

3 participants