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

Update Release Notes Improve Docs #4784

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions .changelog/4784.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
changes:
- description: Improved help message for the *--input* flag in the **update-release-notes** command.
type: feature
pr_number: 4784
2 changes: 1 addition & 1 deletion demisto_sdk/commands/update_release_notes/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ For a private repository and an unconfigured DEMISTO_SDK_GITHUB_TOKEN, remote fi
### Options
* **-i, --input**

The path of the content pack you wish to generate release notes for.
The pack name or relative path of the content pack. For example, 'Packs/Pack_Name'.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
The pack name or relative path of the content pack. For example, 'Packs/Pack_Name'.
The pack name or relative path of the content pack you wish to generate release notes for. For example, 'Packs/Pack_Name'.


* **-u, --update-type**

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ def update_release_notes(
None,
"-i",
"--input",
help="The relative path of the content pack. For example Packs/Pack_Name",
help="The pack name or relative path of the content pack. For example, 'Packs/Pack_Name'.",
),
update_type: UpdateType = typer.Option(
None,
Expand Down
Loading