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

plattformio-home: add alias page #5407

Closed
wants to merge 2 commits into from

Conversation

marchersimon
Copy link
Collaborator

platformio-home is an alias of pio-home (#5406)

@marchersimon marchersimon added the new command Issues requesting creation of a new page. label Mar 10, 2021
@tldr-bot
Copy link

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

pages/common/platformio-home.md:4 MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "- View documentation for the o..."]
pages/common/platformio-home.md:4: TLDR007 Example descriptions should be surrounded by empty lines

Please fix the error(s) and push again.

@bl-ue
Copy link
Contributor

bl-ue commented Mar 10, 2021

Hmm...I haven't thought about alias pages for the parent commands. 🤔

The only reason I'd advise against it would be because it would create a lot of pages (however many aliases of the root command × however many subcommands 😬). But I think that probably doesn't matter.

But I'd like @sbrl to see, because she's supporting this idea :)

@bl-ue bl-ue requested a review from sbrl March 10, 2021 19:16
@marchersimon
Copy link
Collaborator Author

@bl-ue sure, I'll just do the original subcomands for now.

Copy link
Contributor

@bl-ue bl-ue left a comment

Choose a reason for hiding this comment

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

But let's keep this one anyway.

@sbrl
Copy link
Member

sbrl commented Mar 13, 2021

Hrm, this is an interesting case. I'm on the fence about this actually, in that I'm somewhat concerned about the large number of aliases as @bl-ue mentions.

I would guess that you'd try tldr platformio if a subcommand doesn't work though, and then you'd see the alias message? I'm not sure I'm convinced that aliases for every subcommand of an aliased parent command are really necessary.

@marchersimon
Copy link
Collaborator Author

@sbrl I also think that would be too much. Just having the platformio alias seems fine to me.

@sbrl
Copy link
Member

sbrl commented Mar 13, 2021

I'm closing this PR, but we can always reopen if there's more to discuss.

@sbrl sbrl closed this Mar 13, 2021
@marchersimon marchersimon deleted the platformio-home branch April 2, 2021 16:21
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.

4 participants