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

set: add page #2294

Merged
merged 6 commits into from
Sep 6, 2018
Merged

set: add page #2294

merged 6 commits into from
Sep 6, 2018

Conversation

mfrw
Copy link
Member

@mfrw mfrw commented Sep 4, 2018

Closes #2268


  • The page (if new), does not already exist in the repo.

  • The page (if new), has been added to the correct platform folder:
    common/ if it's common to all platforms, linux/ if it's Linux-specific, and so on.

  • The page has 8 or fewer examples.

  • The PR is appropriately titled:
    <command name>: add page for new pages, or <command name>: <description of changes> for pages being edited.

  • The page follows the contributing guidelines.

@tldr-bot
Copy link

tldr-bot commented Sep 4, 2018

The build for this PR has failed with the following error(s):

pages/common/set.md:5: TLDR005 Example descriptions should end in a colon

Please fix the error(s) and push again.

@owenvoke owenvoke added the new command Issues requesting creation of a new page. label Sep 4, 2018
@agnivade
Copy link
Member

agnivade commented Sep 5, 2018

Is this the only example common across all shells ?

@mfrw
Copy link
Member Author

mfrw commented Sep 5, 2018

@agnivade no, there are more but I did not check across all available shells.
Can you suggest which shells should I consider?
I have strong feeling options should be the same for all, but I am not sure.

@agnivade
Copy link
Member

agnivade commented Sep 5, 2018

Since it is in common, windows support is must. So I would say powershell, bash, zsh are essential.

@mfrw
Copy link
Member Author

mfrw commented Sep 5, 2018

@agnivade if we have to include powershell then I would suggest not adding anything else.

@agnivade
Copy link
Member

agnivade commented Sep 5, 2018

You can also split the page into 2. Put one inside windows/ and the other with more options in common/. Windows clients will automatically take the more specific page.

@mfrw
Copy link
Member Author

mfrw commented Sep 5, 2018

@agnivade I think this is a very good idea. Let me split them up into two pages :)
Thanks for the suggestion.

@mfrw
Copy link
Member Author

mfrw commented Sep 6, 2018

@agnivade It turns out that set already had a windows page.

pages/common/set.md Outdated Show resolved Hide resolved
Copy link
Member

@sbrl sbrl left a comment

Choose a reason for hiding this comment

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

Just taken another look got a few more comments for you to review:


- Set various options, e.g. enable `vi` style line editing:

`set -o vi`
Copy link
Member

Choose a reason for hiding this comment

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

Perhaps vi should be surrounded by {{ and }}?

Copy link
Member Author

Choose a reason for hiding this comment

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

Ahhh... yes :(

pages/common/set.md Outdated Show resolved Hide resolved
Copy link
Member

@sbrl sbrl left a comment

Choose a reason for hiding this comment

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

Looks ok to me - thanks @mfrw 😺

@agnivade agnivade merged commit 10e16ab into tldr-pages:master Sep 6, 2018
@mfrw mfrw deleted the feature/set branch September 6, 2018 19:22
@sbrl sbrl mentioned this pull request Sep 7, 2018
@bl-ue bl-ue changed the title set: add page (#2268) set: add page Jun 18, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
new command Issues requesting creation of a new page.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants