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

Fix: multiple documentation tweaks #949

Merged
merged 3 commits into from
Feb 18, 2022
Merged

Fix: multiple documentation tweaks #949

merged 3 commits into from
Feb 18, 2022

Conversation

Poshi
Copy link
Contributor

@Poshi Poshi commented Feb 18, 2022

Related to issue #908
Most of the tweaks are typos. There are a few small modifications and a new branch in a code file to highlight an entire card.
Many files, small data. Please, check carefully, just in case.

Copy link
Owner

@johnkerl johnkerl left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @Poshi , this is an awesome read-through catching lots of things needing fixing! Thanks for your patience in going through it :D

docs/src/glossary.md.in Show resolved Hide resolved
docs/src/file-formats.md.in Show resolved Hide resolved
docs/src/file-formats.md.in Show resolved Hide resolved
docs/src/glossary.md.in Show resolved Hide resolved
docs/src/glossary.md.in Outdated Show resolved Hide resolved
docs/src/reference-dsl-operators.md.in Outdated Show resolved Hide resolved
docs/src/reference-dsl-variables.md.in Outdated Show resolved Hide resolved
docs/src/reference-dsl-variables.md.in Outdated Show resolved Hide resolved
docs/src/reference-dsl-variables.md.in Outdated Show resolved Hide resolved
docs/src/reference-main-number-formatting.md.in Outdated Show resolved Hide resolved
Copy link
Owner

@johnkerl johnkerl left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Changes as requested :)

@@ -35,6 +35,8 @@ Any of the output-format command-line flags (see mlr -h). Example: using
mlr --icsv --opprint put '...' then tee --ojson ./mytap.dat then stats1 ...
the input is CSV, the output is pretty-print tabular, but the tee-file output
is written in JSON format.

Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

I was wondering why to remove these! :)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

At the beginning, I saw the "-h" option multiple times in the same text, so I thought it was superfluous. Later I realized that the text was just the concatenation of the individual help commands, hence each one have its own "-h" flag.
It could make some sense to remove those multiple lines from the compendium, but that meant removing from the individual commands, which was not the expected outcome.
Unfortunately, I realized after pushing the commit. Fortunately, it can be reverted :-)

@Poshi
Copy link
Contributor Author

Poshi commented Feb 18, 2022

Requested changes done

@Poshi Poshi requested a review from johnkerl February 18, 2022 23:06
@@ -37,6 +37,10 @@ def main
lines = read_until_genmd_eof(input_handle)
write_card([], lines, output_handle)

elsif content_line =~ /^GENMD-CARDIFY-HIGHLIGHT-ALL$/
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it's fine -- thank you!! i'll run it locally, no problem, & will let you know if anything needs fixing.

cd docs/src
./genmds # or make forcebuild
cd ..
make
mkdocs serve

is what i'll do

see also https://github.com/johnkerl/miller/blob/main/README-docs.md although that readme is overly complex & i have a to-do to simplify it :)

@johnkerl johnkerl merged commit 8aecba3 into johnkerl:main Feb 18, 2022
johnkerl added a commit that referenced this pull request Feb 18, 2022
@johnkerl
Copy link
Owner

@Poshi I ran make dev & pushed the results at f2fa246

This is great -- thanks again! :)

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

Successfully merging this pull request may close these issues.

2 participants