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

[Documentation] Improvement / Clarification on %section% #541

Open
pa-0 opened this issue Oct 22, 2024 · 0 comments
Open

[Documentation] Improvement / Clarification on %section% #541

pa-0 opened this issue Oct 22, 2024 · 0 comments

Comments

@pa-0
Copy link

pa-0 commented Oct 22, 2024

I'm still new to Shell, otherwise I'd create a pull request with some suggested changes myself. However, I probably would not have caught this if I was already familiar with the program as I currently have the "advantage" of a beginner's perspective. With respect to the following excerpt from the documentation:

Syntax

The general syntax is as follows:

import %path%

Where

  • %section% is the name of a section. Optional. If given, it must be one of
    • settings
    • themes
    • modify-items
    • new-items
    The section name is written literally, without any quotes (or the percent signs).

I think that the documentation could stand to benefit in the way of clarity if the portion addressing the %section% variable were moved into a subsection of import. In it's current state, it is confusing, because the variable is described in detail, but not used in the code example provided.

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

1 participant