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

General Documentation Update #49

Open
anamanica opened this issue Jun 17, 2024 · 1 comment
Open

General Documentation Update #49

anamanica opened this issue Jun 17, 2024 · 1 comment
Labels
documentation Improvements or additions to documentation Student

Comments

@anamanica
Copy link
Contributor

Overview

Update the documentation/README for this python line program to make it clearer in its instructions:

  • Clarify that ‘l0, l1, etc” is a lowercase L, and not an uppercase “i.”
  • In the download section, note that your working directory will be established as the default directory. I.e, the data directory will automatically be placed here. Suggest user to be in /Desktop working directory.
    - To a similar point as the comment above, explain config better for the purpose of changing working directory.
  • In the upload section, note that your working directory must be one level above the file path of the /data directory (where your files must be stored) for uploads to succeed.
  • At the beginning, make note of the troubleshooting section further down.
  • Make it more clear that when downloading a file, it will create folders for each bit of information in the file name.

Related documents or information sources

No response

@anamanica anamanica added the documentation Improvements or additions to documentation label Jun 17, 2024
@bourque
Copy link
Contributor

bourque commented Aug 1, 2024

I noticed another thing to update: The upload and download help documentation indicate that a full path to a file must be used, however this is now outdated. The user may also just provide just the filename.

@bourque bourque added the Student label Aug 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation Student
Projects
Status: No status
Development

No branches or pull requests

2 participants