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 user guide on the usage of Availability #82

Merged
merged 5 commits into from
Mar 16, 2024

Conversation

tsulim
Copy link
Collaborator

@tsulim tsulim commented Mar 15, 2024

Closes #81

Segments to edit:

  • Feature: add
  • Feature: edit
  • Command summary: add and edit

@tsulim tsulim added the type.Documentation Improvements or additions to documentation label Mar 15, 2024
@tsulim tsulim added this to the v1.2 milestone Mar 15, 2024
@tsulim tsulim self-assigned this Mar 15, 2024
Copy link

codecov bot commented Mar 15, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 78.33%. Comparing base (d98567e) to head (9b60700).
Report is 155 commits behind head on master.

Additional details and impacted files
@@             Coverage Diff              @@
##             master      #82      +/-   ##
============================================
+ Coverage     77.29%   78.33%   +1.03%     
- Complexity      472      529      +57     
============================================
  Files            77       86       +9     
  Lines          1493     1620     +127     
  Branches        144      159      +15     
============================================
+ Hits           1154     1269     +115     
- Misses          308      320      +12     
  Partials         31       31              

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


* Edits the person at the specified `INDEX`. The index refers to the index number shown in the displayed person list. The index **must be a positive integer** 1, 2, 3, …​
* At least one of the optional fields must be provided.
* Existing values will be updated to the input values.
* When editing tags, the existing tags of the person will be removed i.e adding of tags is not cumulative.
* You can remove all the person’s tags by typing `t/` without
specifying any tags after it.
* When editing availabilities, the existing availabilites of the person will be removed i.e adding of availabilities is not cumulative.
* You can remove all the person’s availabilities by typing `a/` without
Copy link

@Pluiexo Pluiexo Mar 15, 2024

Choose a reason for hiding this comment

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

Would like to link the same issue in #80 , would the empty list indicate availability for all days of the week?

Copy link

@Pluiexo Pluiexo left a comment

Choose a reason for hiding this comment

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

LGTM! Just the same issue questioned in the implementation PR

docs/UserGuide.md Outdated Show resolved Hide resolved
amend example to include availability
Copy link
Collaborator

@whitesnowx whitesnowx left a comment

Choose a reason for hiding this comment

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

LOOK GOOD TO ME 🤸‍♂️

/APPROVE

@whitesnowx whitesnowx merged commit 22b7d45 into AY2324S2-CS2103-F08-3:master Mar 16, 2024
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type.Documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update features that uses the Availability attribute in user guide
4 participants