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

refactor documentation of operators, document + for strings and paths #7498

Merged
merged 7 commits into from
Jan 6, 2023
Merged

refactor documentation of operators, document + for strings and paths #7498

merged 7 commits into from
Jan 6, 2023

Commits on Jan 5, 2023

  1. reorder columns 

    this is for a simpler transformation into a series of subsections
    @fricklerhandwerk
    fricklerhandwerk committed Jan 5, 2023
    Configuration menu
    Copy the full SHA
    caebe41 View commit details
    Browse the repository at this point in the history

  2. convert table to subsections 

    this form is much easier to maintain (also with minimal diffs), and
allows for more details on each operator.

this change a purely mechanical transformation, without changing any contents.
    @fricklerhandwerk
    fricklerhandwerk committed Jan 5, 2023
    Configuration menu
    Copy the full SHA
    e07448b View commit details
    Browse the repository at this point in the history

  3. reword descriptions of operators 

    add notes on semantics where appropriate
    @fricklerhandwerk
    fricklerhandwerk committed Jan 5, 2023
    Configuration menu
    Copy the full SHA
    63b640e View commit details
    Browse the repository at this point in the history

  4. add semantics of overloaded + operator

    @fricklerhandwerk
    fricklerhandwerk committed Jan 5, 2023
    Configuration menu
    Copy the full SHA
    969e5ad View commit details
    Browse the repository at this point in the history

  5. use more self-explanatory placeholder names

    @fricklerhandwerk
    fricklerhandwerk committed Jan 5, 2023
    Configuration menu
    Copy the full SHA
    7b2b9e3 View commit details
    Browse the repository at this point in the history

  6. add links to documentation for data types

    @fricklerhandwerk
    fricklerhandwerk committed Jan 5, 2023
    Configuration menu
    Copy the full SHA
    7da59e9 View commit details
    Browse the repository at this point in the history

  7. bring back table, extract annotations 

    this makes the table less unwieldy, and leaves enough space for
extensive explanations.
    @fricklerhandwerk
    fricklerhandwerk committed Jan 5, 2023
    Configuration menu
    Copy the full SHA
    e57165b View commit details
    Browse the repository at this point in the history