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.

Sign up for GitHub

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

Jump to bottom

Fixup and improve book using_modules.md #1608

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open

Fixup and improve book using_modules.md #1608

wants to merge 6 commits into from

Commits on Nov 1, 2024

  1. Fix absolute path example item text 

    The relative example follows afterwards. This block only contains docs on absolute paths.
    @Kissaki
    Kissaki committed Nov 1, 2024
    Configuration menu
    Copy the full SHA
    bf790aa View commit details
    Browse the repository at this point in the history

  2. Fix NU_LIB_PATH -> NU_LIB_DIRS 

    `$env.NU_LIB_PATH` does not exist

In the block that follows the correct name is being used.
    @Kissaki
    Kissaki committed Nov 1, 2024
    Configuration menu
    Copy the full SHA
    9eea190 View commit details
    Browse the repository at this point in the history

  3. Remain consistent across code examples 

    The blocks demonstrate different things, but it's confusing to have different code - mixing both behavior changes through context and unnecessary code changes.
    @Kissaki
    Kissaki committed Nov 1, 2024
    Configuration menu
    Copy the full SHA
    eec9199 View commit details
    Browse the repository at this point in the history

  4. Fix sentence wording

    @Kissaki
    Kissaki committed Nov 1, 2024
    Configuration menu
    Copy the full SHA
    f790b3f View commit details
    Browse the repository at this point in the history

  5. Simplify sentences by dropping 'simply' 

    Increases readability and clarity.

Using 'simply' can indicate that actions are simple. But adding it without a need for differentiation or qualification, they increase sentence complexity, making it harder to read and parse. The statements remain just as valid without them.
    @Kissaki
    Kissaki committed Nov 1, 2024
    Configuration menu
    Copy the full SHA
    41f99b4 View commit details
    Browse the repository at this point in the history

  6. Split absolute and relative path examples 

    The concern before this one already has split sections.

Rather than a block with two mixed concerns, and a need for "or"  text in a mixed-concern example attempting to demonstrate two things at once,
having two blocks makes it much more obvious, distinct, and reference-able (when the reader is only interested in one aspect).

It also simplifies the NU_LIB_DIRS concern a lot. Instead of a long block headline with a lot of mixed information, we do the same as the other concern earlier in the document:
note the information in an important note block.
    @Kissaki
    Kissaki committed Nov 1, 2024
    Configuration menu
    Copy the full SHA
    1abe662 View commit details
    Browse the repository at this point in the history