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.

Sign up for GitHub

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

Jump to bottom

Docs - Inconsistent docs for the parameter "-WorkingDirectory" in Install-ChocolateyShortcut #1234

Closed
OlafHaag opened this issue Apr 4, 2017 · 3 comments
Closed

Docs - Inconsistent docs for the parameter "-WorkingDirectory" in Install-ChocolateyShortcut #1234

OlafHaag opened this issue Apr 4, 2017 · 3 comments
Assignees
@gep13
Labels
5 - Released Bug Documentation NO RELEASE NOTES Should not be included in the release notes - not enhancing or fixing end product. Up For Grabs
Milestone
0.10.12

Comments

@OlafHaag
Copy link

OlafHaag commented Apr 4, 2017

What You Are Seeing?

Inconsistent use for the parameter "-WorkingDirectory" in Install-ChocolateyShortcut helper function documentation. In Example 2 it's "-WorkDirectory", in the chocolateyInstall.ps1 that comes with choco new it's "-workDirectory".

What is Expected?

That it's always called "-WorkingDirectory" in order to not confuse me and make errors.

How Did You Get This To Happen? (Steps to Reproduce)

choco new, and looking at the docs: https://chocolatey.org/docs/helpers-install-chocolatey-shortcut, looking at the source code
@ferventcoder ferventcoder added this to the 0.10.6 milestone Apr 5, 2017
@ferventcoder
Copy link
Member

Documentation bug. Up for grabs.

@ferventcoder ferventcoder modified the milestones: 0.10.6, 0.10.7 Apr 28, 2017
@ferventcoder ferventcoder modified the milestones: 0.10.7, 0.10.8 Jun 6, 2017
@ferventcoder ferventcoder modified the milestones: 0.10.9, 0.10.10 Aug 27, 2017
@ferventcoder ferventcoder modified the milestones: 0.10.10, 0.10.12 Mar 27, 2018
@ferventcoder ferventcoder modified the milestones: 0.10.12, 0.10.13 May 3, 2018
@steviecoaster steviecoaster mentioned this issue Feb 17, 2019
Closed
@ferventcoder ferventcoder mentioned this issue Mar 6, 2019
Closed
@ferventcoder ferventcoder modified the milestones: 0.10.13, 0.10.14 Mar 9, 2019
gep13 pushed a commit that referenced this issue Mar 11, 2019
@steviecoaster @gep13
(GH-1234) Fix typo in Parameter definition
2a0f42a 
This is a small fix to the Parameter definition of
Install-ChocolateyShortcut.ps1. This aligns $WorkingDirectory to be the
same name in the Comment Based Help and Param() block. This will also
fix the upstream documentation for the command on chocolatey.org.
gep13 added a commit that referenced this issue Mar 11, 2019
@gep13
Merge branch 'pr1730' into stable
26ace80 
* pr1730:
  (maint) Corrected whitespace
  (GH-1234) Fix typo in Parameter definition
gep13 added a commit that referenced this issue Mar 11, 2019
@gep13
Merge branch 'stable'
2e60e99 
* stable:
  (maint) Corrected whitespace
  (GH-1234) Fix typo in Parameter definition
  (maint) formatting
  (GH-1580) Only log when RegularOutput is enabled
  (maint) Whitespace changes
@gep13 gep13 modified the milestones: 0.10.14, 0.10.12 Mar 11, 2019
@gep13
Copy link
Member

gep13 commented Mar 11, 2019

This was merged into stable at 26ace80

@gep13
Copy link
Member

gep13 commented Mar 11, 2019

Merged into stable to be released with 0.10.12.

@gep13 gep13 closed this as completed Mar 11, 2019
@ferventcoder ferventcoder changed the title Inconsistent docs for the parameter "-WorkingDirectory" in Install-ChocolateyShortcut Docs -Inconsistent docs for the parameter "-WorkingDirectory" in Install-ChocolateyShortcut Mar 13, 2019
@ferventcoder ferventcoder added the NO RELEASE NOTES Should not be included in the release notes - not enhancing or fixing end product. label Mar 13, 2019
@ferventcoder ferventcoder changed the title Docs -Inconsistent docs for the parameter "-WorkingDirectory" in Install-ChocolateyShortcut Docs - Inconsistent docs for the parameter "-WorkingDirectory" in Install-ChocolateyShortcut Mar 13, 2019
corbob added a commit to corbob/choco that referenced this issue May 15, 2022
@corbob
(chocolatey#1234) Something or other
27c0440 
lkjdf lkj lkj lkj lkj asdfsadfasdf lkjdf lkj lkj lkj lkj asdfsadfasdf
lkjdf lkj lkj lkj lkj asdfsadfasdf lkjdf lkj lkj lkj lkj asdfsadfasdf
lkjdf lkj lkj lkj lkj asdfsadfasdf lkjdf lkj lkj lkj lkj asdfsadfasdf
lkjdf lkj lkj lkj lkj asdfsadfasdf lkjdf lkj lkj lkj lkj asdfsadfasdf
lkjdf lkj lkj lkj lkj asdfsadfasdf lkjdf lkj lkj lkj lkj asdfsadfasdf
lkjdf lkj lkj lkj lkj asdfsadfasdf lkjdf lkj lkj lkj lkj asdfsadfasdf
lkjdf lkj lkj lkj lkj asdfsadfasdf lkjdf lkj lkj lkj lkj asdfsadfasdf
lkjdf lkj lkj lkj lkj asdfsadfasdf lkjdf lkj lkj lkj lkj asdfsadfasdf
lkjdf lkj lkj lkj lkj asdfsadfasdf lkjdf lkj lkj lkj lkj asdfsadfasdf
lkjdf lkj lkj lkj lkj asdfsadfasdf lkjdf lkj lkj lkj lkj asdfsadfasdf
lkjdf lkj lkj lkj lkj asdfsadfasdf lkjdf lkj lkj lkj lkj asdfsadfasdf
lkjdf lkj lkj lkj lkj asdfsadfasdf lkjdf lkj lkj lkj lkj asdfsadfasdf
lkjdf lkj lkj lkj lkj asdfsadfasdf lkjdf lkj lkj lkj lkj asdfsadfasdf
lkjdf lkj lkj lkj lkj asdfsadfasdf lkjdf lkj lkj lkj lkj asdfsadfasdf
lkjdf lkj lkj lkj lkj asdfsadfasdf lkjdf lkj lkj lkj lkj asdfsadfasdf
lkjdf lkj lkj lkj lkj asdfsadfasdf lkjdf lkj lkj lkj lkj asdfsadfasdf
lkjdf lkj lkj lkj lkj asdfsadfasdf lkjdf lkj lkj lkj lkj asdfsadfasdf
lkjdf lkj lkj lkj lkj asdfsadfasdf lkjdf lkj lkj lkj lkj asdfsadfasdf
lkjdf lkj lkj lkj lkj asdfsadfasdf lkjdf lkj lkj lkj lkj asdfsadfasdf
lkjdf lkj lkj lkj lkj asdfsadfasdf
corbob added a commit to corbob/choco that referenced this issue May 15, 2022
@corbob
(chocolatey#1234) Some message.
8a8e059 
No new line this time. Let's see how long we can make this line. We'll
just keep typing, and have it be long enough to wrap a few times. How
much more do you think we need? We're at > 100 beyond 72 🤷 Might
as well keep going. Maybe we'll stop at 300? Or perhaps 4? Naw, let's
just do it 200.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@gep13 gep13

Labels
5 - Released Bug Documentation NO RELEASE NOTES Should not be included in the release notes - not enhancing or fixing end product. Up For Grabs
Projects
None yet
Milestone
0.10.12
Development

Successfully merging a pull request may close this issue.

(GH-1234) Fix typo in Parameter definition of Context Based Help
3 participants
@ferventcoder @gep13 @OlafHaag