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

[#1968] Incorrect dropdown box for config in UG: Customizing Report #2009

Merged
merged 7 commits into from
Jul 10, 2023

Conversation

germainelee02
Copy link
Contributor

@germainelee02 germainelee02 commented Jun 23, 2023

Fixes #1968

There is a bug in the UG where the assets syntax is incorrectly
displayed under the config section instead of the correct config
syntax. This could potentially confuse users.

Let's fix the bug by displaying the correct config syntax, and add a
link to the page that explains the format of config files, for user
convenience.

https://docs-1950-pr-reposense-reposense.surge.sh/ug/customizingReports.html#customize-using-csv-config-files

Copy link
Contributor

@vvidday vvidday left a comment

Choose a reason for hiding this comment

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

Thanks for your work on this @germainelee02!

Also have a minor comment on the commit message - we usually use Let's ... for the changes being done in the PR, and use an imperative mood instead of past tense. Also, it would be good to include a short statement on "why it needs to change" (even though it's quite obvious in this case).

More info under 'commit message body'

Something like the following (feel free to change as you see fit!):

There is a bug in the UG where the assets syntax is incorrectly
displayed under the config section instead of the correct config
syntax. This could potentially confuse users.

Let's fix the bug by displaying the correct config syntax, and add a
link to the page that explains the format of config files, for user
convenience.

docs/ug/cli.md Outdated Show resolved Hide resolved
@github-actions
Copy link
Contributor

The following links are for previewing this pull request:

@germainelee02 germainelee02 reopened this Jun 27, 2023
Copy link
Contributor

@vvidday vvidday left a comment

Choose a reason for hiding this comment

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

LGTM!

@vvidday vvidday requested a review from a team June 27, 2023 13:49
Copy link
Member

@MarcusTXK MarcusTXK left a comment

Choose a reason for hiding this comment

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

LGTM, nice job!

@MarcusTXK MarcusTXK requested a review from a team June 28, 2023 09:29
Copy link
Contributor

@chan-j-d chan-j-d left a comment

Choose a reason for hiding this comment

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

LGTM!

@chan-j-d chan-j-d merged commit 95f97da into reposense:master Jul 10, 2023
10 checks passed
@github-actions
Copy link
Contributor

The following links are for previewing this pull request:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Incorrect dropdown box for config in UG: Customizing Report
4 participants