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 (fix inaccurate commands, improve ordering) #128

Merged
merged 9 commits into from
Nov 1, 2022

Conversation

mjgui
Copy link

@mjgui mjgui commented Oct 28, 2022

Just an initial PR to improve the UG

Other potential things to do

  • Update the command summary table (and potentially move it to the top)
  • Add hyperlinks to navigate around the document
  • Improve the language at the top of the User Guide
  • Improve based on CS2101 feedback

Fixes

Fixes #168
Fixes #163
Fixes #161
Fixes #158
Fixes #157
Fixes #153
Fixes #152
Fixes #151
Fixes #149
Fixes #148
Fixes #147
Fixes #146
Fixes #144
Fixes #142
Fixes #141
Fixes #137
Fixes #135
Fixes #130

Partially fixes but does not close #132 (confusing error messages)

@codecov-commenter
Copy link

codecov-commenter commented Oct 28, 2022

Codecov Report

Base: 39.13% // Head: 39.56% // Increases project coverage by +0.42% 🎉

Coverage data is based on head (59b0da7) compared to base (af503b5).
Patch has no changes to coverable lines.

Additional details and impacted files
@@             Coverage Diff              @@
##             master     #128      +/-   ##
============================================
+ Coverage     39.13%   39.56%   +0.42%     
- Complexity      457      512      +55     
============================================
  Files           143      147       +4     
  Lines          2619     2861     +242     
  Branches        327      371      +44     
============================================
+ Hits           1025     1132     +107     
- Misses         1529     1654     +125     
- Partials         65       75      +10     
Impacted Files Coverage Δ
...in/java/seedu/address/logic/parser/ParserUtil.java 55.05% <0.00%> (-8.59%) ⬇️
...in/java/seedu/address/storage/JsonAdaptedTeam.java 84.84% <0.00%> (-7.66%) ⬇️
...ain/java/seedu/address/model/team/Description.java 66.66% <0.00%> (ø)
...edu/address/logic/parser/DescriptionConverter.java 25.00% <0.00%> (ø)
...c/main/java/seedu/address/model/team/TeamName.java 72.72% <0.00%> (ø)
.../seedu/address/logic/parser/TeamNameConverter.java 25.00% <0.00%> (ø)
src/main/java/seedu/address/model/team/Team.java 43.52% <0.00%> (+1.69%) ⬆️
.../seedu/address/logic/commands/EditTeamCommand.java 18.47% <0.00%> (+2.11%) ⬆️
...a/seedu/address/logic/commands/SetTeamCommand.java 12.50% <0.00%> (+2.50%) ⬆️
...eedu/address/logic/commands/DeleteTeamCommand.java 12.50% <0.00%> (+2.50%) ⬆️
... and 2 more

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

@marcuspang
Copy link

marcuspang commented Oct 30, 2022

UG Bugs

Devanshshah1309
Devanshshah1309 previously approved these changes Nov 1, 2022
docs/UserGuide.md Outdated Show resolved Hide resolved
docs/UserGuide.md 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 Show resolved Hide resolved
docs/UserGuide.md Show resolved Hide resolved
docs/UserGuide.md Show resolved Hide resolved
@Devanshshah1309 Devanshshah1309 self-requested a review November 1, 2022 03:07
@Devanshshah1309 Devanshshah1309 dismissed their stale review November 1, 2022 03:10

Revoke approval

@marcuspang
Copy link

Remaining issues will be addressed in #84

@marcuspang marcuspang self-assigned this Nov 1, 2022
Copy link

@Devanshshah1309 Devanshshah1309 left a comment

Choose a reason for hiding this comment

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

Preliminary changes LGTM. Approving since the rest of the changes will be made in a separate PR (as discussed internally)

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