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

Please add some help for reading documentation #1554

Open
shaib opened this issue Aug 27, 2019 · 1 comment
Open

Please add some help for reading documentation #1554

shaib opened this issue Aug 27, 2019 · 1 comment

Comments

@shaib
Copy link
Contributor

shaib commented Aug 27, 2019

Issue description

The Introduction to the command-line interface chapter includes a section instructing the user to learn more about the command by asking for its documentation. On Windows, this is cd /?. The output of this command starts with this (up to minor variations per Windows version):

C:\Users\Shai>cd /?
Displays the name of or changes the current directory.

CHDIR [/D] [drive:][path]
CHDIR [..]
CD [/D] [drive:][path]
CD [..]

  ..   Specifies that you want to change to the parent directory.

When I was going through this with a youth who has been using computers a lot (and even dabbled with some Python) but really needed this chapter -- the command line is completely new to her -- this looked very daunting. I had to explain what the square brackets mean, what the drives are, and even what's a parent directory.

I don't think everything needs to be explained here, but at least some syntax (like brackets) should be, and perhaps a reference to fuller explanations about the file-system; and most importantly, a disclaimer along the lines of "don't worry if not all seems clear now, it will become clearer as you move along".

Language

I haven't checked translations, but I believe English is the source...

Operating system

Windows is much scarier than Unix in this regard, because the Unix manuals have headings ("Name", "Synopsys", "Descriptions") which Windows help files lack.

@das-g
Copy link
Member

das-g commented Aug 27, 2019

🤔 Can we just combine the "don't worry if not all seems clear now, it will become clearer as you move along" disclaimer with a link to preexisting more in-depth material on the topic and be done with it? A(nother) lengthy explanation might make the tutorial itself more daunting.

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

No branches or pull requests

2 participants