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

Update Nushell Book with copy-able examples. #1692

Merged
merged 12 commits into from
Dec 22, 2024
Merged

Conversation

0x4D5352
Copy link
Contributor

Based on Issue #1684. I've left two sections in the book unchanged pending additional comments:

  1. how_nushell_gets_run.md - the REPL section specifically calls out the prompt indicator > .
  2. overlays.md - Lines 63-66 specifically call out the indicator and the overlay prefix.

In some cases, I added the # => prefix to example outputs that were not attached to a command example with a > prefix to maintain consistency across examples, unless the example output was presented in isolation. However, I may have missed some instances.

@0x4D5352
Copy link
Contributor Author

As per @NotTheDr01ds comment in the issue, I'm keeping any instance of the prompt where it's explicitly called out as part of the example.

@0x4D5352
Copy link
Contributor Author

Noticed that there was still a page in both Spanish and Portuguese for the deprecated shells command, removing them as per a conversation in Discord.

@NotTheDr01ds
Copy link
Contributor

Wow! Thank you for this cleanup!

I've caught a few things that the search/replace didn't quite seem to handle quite right.

Unfortunately, I could only review up to about halfway through the Spanish book before my browser crashed due to (I'm guessing) the length. We might need to split PRs like this up into smaller chunks :-)

Copy link
Contributor

@NotTheDr01ds NotTheDr01ds left a comment

Choose a reason for hiding this comment

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

The review comments might not have appeared last night because of the browser crash. Resubmitting.

book/environment.md Outdated Show resolved Hide resolved
book/environment.md Outdated Show resolved Hide resolved
book/navigating_structured_data.md Outdated Show resolved Hide resolved
book/pipelines.md Outdated Show resolved Hide resolved
book/pipelines.md Outdated Show resolved Hide resolved
book/pipelines.md Outdated Show resolved Hide resolved
book/pipelines.md Outdated Show resolved Hide resolved
book/types_of_data.md Outdated Show resolved Hide resolved
book/working_with_records.md Outdated Show resolved Hide resolved
de/book/loading_data.md Outdated Show resolved Hide resolved
@0x4D5352
Copy link
Contributor Author

@NotTheDr01ds Indentation's been fixed; the "When does $in change" list has also been conformed to the same style throughout. Between that and your smaller suggested fixes, this should be good to go.

@NotTheDr01ds NotTheDr01ds merged commit 97e7cab into nushell:main Dec 22, 2024
2 checks passed
@NotTheDr01ds
Copy link
Contributor

Thanks! Merged! (Again) Great cleanup!

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