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 UG: Improve from PED #246

Merged

Conversation

wasjoe1
Copy link
Collaborator

@wasjoe1 wasjoe1 commented Nov 8, 2023

Let's make improvements in our UG to tackle bugs found during PED.

  • Specify definition of words
  • Include clear feature, clear guest and clear vendor will be implemented in the future
  • Mentions that a person can be recorded as both a guest & vendor
  • Rectify error messages

resolves #214
resolves #209
resolves #192

@wasjoe1 wasjoe1 added this to the v1.4 milestone Nov 8, 2023
Copy link

codecov bot commented Nov 8, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (4429706) 90.22% compared to head (8f302fa) 90.22%.

Additional details and impacted files
@@            Coverage Diff            @@
##             master     #246   +/-   ##
=========================================
  Coverage     90.22%   90.22%           
  Complexity      830      830           
=========================================
  Files           100      100           
  Lines          2260     2260           
  Branches        305      305           
=========================================
  Hits           2039     2039           
  Misses          161      161           
  Partials         60       60           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link

@samuelim01 samuelim01 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 the hard work :) Just a few nits!

docs/UserGuide.md Outdated Show resolved Hide resolved
docs/UserGuide.md Outdated Show resolved Hide resolved
docs/UserGuide.md Outdated Show resolved Hide resolved
docs/UserGuide.md Outdated Show resolved Hide resolved
docs/UserGuide.md Outdated Show resolved Hide resolved
docs/UserGuide.md Outdated Show resolved Hide resolved
docs/UserGuide.md Outdated Show resolved Hide resolved
docs/UserGuide.md Outdated Show resolved Hide resolved
docs/UserGuide.md Outdated Show resolved Hide resolved
@@ -64,6 +64,8 @@ WedLog is a desktop app for wedding planning, optimized for use via a Command Li

**Notes about the command format:** <br />

* Words are defined to be any letters, numbers or special characters of length 1 or more

Choose a reason for hiding this comment

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

Based on #214, I believe this still means that users who look the section on Address without seeing this small note will still perceive the single digit integer to be not very meaningful. Is it possible to just specify the acceptable values for Address directly as "any non blank values", or something along those lines? We can still keep this definition here for the purposes of the "alphanumeric words" of names, etc.

@samuelim01
Copy link

Oh by the way, if you want your PR to automatically close the issues your mentioned, I think you left out the closing keywords

Copy link

@samuelim01 samuelim01 left a comment

Choose a reason for hiding this comment

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

LGTM! 😄

@samuelim01 samuelim01 merged commit 535201d into AY2324S1-CS2103T-F11-2:master Nov 9, 2023
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
2 participants