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

nvm.fish: add page #7512

Merged
merged 3 commits into from
Jan 6, 2022
Merged

nvm.fish: add page #7512

merged 3 commits into from
Jan 6, 2022

Conversation

reinhart1010
Copy link
Collaborator

  • The page (if new), does not already exist in the repository.
  • The page is in the correct platform directory (common/, linux/, etc.)
  • The page has 8 or fewer examples.
  • The PR title conforms to the recommended templates.
  • The page follows the content guidelines.
  • The page description includes a link to documentation or a homepage (if applicable).

Version of the command being documented (if known): 2.2.6

This is related to our discussion on #7480. However, this might break some tldr clients as this is the first known file to have more than one dot characters (.).

@github-actions github-actions bot added the new command Issues requesting creation of a new page. label Dec 6, 2021
@tldr-bot
Copy link

tldr-bot commented Dec 6, 2021

Hello! I've noticed something unusual when checking this PR:

  • The page common/nvm.fish.md seems to be a copy of common/nvm.md (56% matching).

Is this intended? If so, just ignore this comment. Otherwise, please double-check the commits.

@navarroaxel navarroaxel changed the title nvm.fish: Add page nvm.fish: add page Dec 6, 2021
@@ -0,0 +1,25 @@
# nvm.fish
Copy link
Collaborator

@nicokosi nicokosi Dec 7, 2021

Choose a reason for hiding this comment

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

If I understand correctly, the binary is nvm so I think there is a mismatch here.
Moreover, the CLI interface seems similar to https://github.com/nvm-sh/nvm so I am not sure this whole page is needed (it seems to overlap with #7511). 💭

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

There are several differences between the original nvm with this version. In short, currently the commands between both versions aren't compatible with each other:

  1. No nvm run or nvm exec (though I can just create a PR for that 😀)
  2. The default Node.js version is set through set instead of a subcommand (again, even though I can just PR about it 😅)

Maybe I should close this PR by sending a couple to https://github.com/jorgebucaran/nvm.fish...

Copy link
Collaborator

@nicokosi nicokosi Dec 7, 2021

Choose a reason for hiding this comment

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

Thanks for the detailed information. 👍
I understand that commands are different. 👌
But I don't understand what to do with the mismatch between the binary name (nvm) and the page name (we would need to run tldr nvm.fish to find it, if I understand correctly). 🤔

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

There's a bunch of related discussions related to this:

  1. Help documenting other variants of NVM (Node Version Manager) #7480 - The one I've referenced here
  2. Group commands by shells #7503 - Plans to separate commands by shells, if so I can move this into something like common/fish/nvm
  3. Let's document: PowerShell #6621 - PowerShell, related to Group commands by shells #7503

Copy link
Member

Choose a reason for hiding this comment

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

The title of a page needs to exactly match the command name being executed. This is not the case for the filename.

  • Filename: nvm.fish.md
  • Page title: nvm
  • Command being executed: nvm

Ideally the page title and the filename will match, but this is unfortunately not always possible.

Copy link
Member

Choose a reason for hiding this comment

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

For completeness, the command in question where it's also not possible is rename.

Co-authored-by: CleanMachine1 <78213164+CleanMachine1@users.noreply.github.com>

- Set the default Node.js version:

`set nvm_default_version {{node_version}}`
Copy link
Member

Choose a reason for hiding this comment

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

Is this a typo? Should this be prefixed by nvm at all, or is this essentially updating an environment variable that nvm (fish) reads?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Yes it uses the Fish' builtin set command to set the default version.

@github-actions
Copy link

github-actions bot commented Jan 3, 2022

Hi all! This thread has not had any recent activity.
Are there any updates? Thanks!

@github-actions github-actions bot added the waiting Issues/PRs with Pending response by the author. label Jan 3, 2022
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.

Thanks, @reinhart1010!

@sbrl sbrl merged commit 6a483fd into tldr-pages:main Jan 6, 2022
@reinhart1010 reinhart1010 deleted the nvm-fish branch July 12, 2022 01:04
@pixelcmtd pixelcmtd removed the waiting Issues/PRs with Pending response by the author. label May 2, 2023
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.

7 participants