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

docs: fix documentation concerning glob expansion on UNIX #4869

Merged
merged 4 commits into from
Mar 12, 2024

Commits on Apr 11, 2022

  1. Configuration menu
    Copy the full SHA
    ead1635 View commit details
    Browse the repository at this point in the history

Commits on Mar 5, 2024

  1. Increase concision.

    Co-authored-by: Josh Goldberg ✨ <git@joshuakgoldberg.com>
    binki and JoshuaKGoldberg authored Mar 5, 2024
    Configuration menu
    Copy the full SHA
    d5c86e2 View commit details
    Browse the repository at this point in the history

Commits on Mar 12, 2024

  1. Remove reference to misleading article and any platforms

    mochajs#4869 (review) requested that platforms and shells not be mentioned. This means that rationale for the directions cannot be provided.
    
    The article which was originally linked suggests to use single quotes which do not work on Windows. For example, using single quotes for a glob expression referring to a folder or file with `&` in its name would break the expression into two commands on Windows.
    
    Since the rationale was removed and the linked article was misleading, instructions on how to correctly quote globs were added. The rationale is recorded here since it isn’t allowed in the instructions:
    
    * Since a Unix-like OS user would be accustomed to referencing a path containing `"` in it by writing `\"` within a double-quoted string, I mentioned that the double quote and backslash characters are forbidden.
    * Since a Windows user would be accustomed to including `$` in file names but double quoted strings have parameter expansion performed on them on on Unix-like OSes, I had to mention that `$` is a forbidden character.
    * Since Windows doesn’t support single quotes, I had to mention that double quotes are required.
    binki authored Mar 12, 2024
    Configuration menu
    Copy the full SHA
    ab6bed3 View commit details
    Browse the repository at this point in the history
  2. Accept wording change

    Co-authored-by: Pelle Wessman <pelle@kodfabrik.se>
    binki and voxpelli authored Mar 12, 2024
    Configuration menu
    Copy the full SHA
    7129fbf View commit details
    Browse the repository at this point in the history