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

#308 Fixes badly documented softwareName #451

Closed
wants to merge 2 commits into from

Conversation

C0smin
Copy link

@C0smin C0smin commented Apr 6, 2022

Description Of Changes

This change removes all examples that mention softwareName as this is not used in code.

Motivation and Context

Created this PR because I would like to improve the documentation with true to life examples.

Testing

  • No testing done since this changes do not add any new functionality/feature.

Change Types Made

  • Minor documentation fix (typos etc.).

Change Checklist

  • Requires a change to menu structure (top or left hand side)/
  • Menu structure has been updated

Fixes #308

@gep13
Copy link
Member

gep13 commented Apr 6, 2022

@C0smin before we can move forward with this, we would need you to fill in the Pull Request Template that you should have been presented with when you created the PR.

Why exactly is this change required?

@C0smin
Copy link
Author

C0smin commented Apr 6, 2022

@gep13, I updated the PR description. In short I'm trying to make sure that the documentation is up to date.

@TheCakeIsNaOH
Copy link
Member

@C0smin the softwareName parameter is planned to be implemented at some point. See: chocolatey/choco#2513

So the solution to #308 would be to get it implemented into Chocolatey CLI, and add documentation for it.

@ryanrichter94 ryanrichter94 added Documentation Issues for changes that only need to change documentation Requires Upstream Change Requires changes to a different location once issue is fixed or implemented labels Sep 30, 2022
@ryanrichter94
Copy link
Member

Added tags to this PR to reflect @TheCakeIsNaOH's last reply that changes in Chocolatey CLI will need made before a docs improvement around the softwareName parameter can be made.

@gep13
Copy link
Member

gep13 commented Nov 2, 2022

@C0smin thank you for taking the time to raise this PR. Based on the existing issue for documenting the parameter #308 and the other existing issue for making use of it chocolatey/choco#2513 I am going to go ahead and close out this PR.

Let me know if you have any questions about why this is being done.

@gep13 gep13 closed this Nov 2, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Issues for changes that only need to change documentation Requires Upstream Change Requires changes to a different location once issue is fixed or implemented
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Undocumented softwareName parameter in package function examples
4 participants