Skip to content

Commit

Permalink
Fix checkstyles in docs to make github happy
Browse files Browse the repository at this point in the history
  • Loading branch information
yarnmeng committed Nov 13, 2023
1 parent 7751b23 commit eeda817
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 11 deletions.
12 changes: 6 additions & 6 deletions docs/UserGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -227,9 +227,9 @@ New task added: Draft assignments; Priority: 1; Status: undone; Tags: [assignmen
**Precise Expected Outputs when the command fails:**

```
Invalid command format!
Invalid command format!
add: Adds a task to the task list.
Compulsory Parameters: n/[name] p/[priority] d/[dueDate]
Compulsory Parameters: n/[name] p/[priority] d/[dueDate]
Optional Parameters: recur/[recur] t/[tag...] l/[link] des/[description]
Example: add n/Grade assignments p/1 t/assignment t/grade d/01-01-2023 l/www.example.com
```
Expand Down Expand Up @@ -270,10 +270,10 @@ Edited Task: Grant Application; Priority: 10; Status: undone; Tags: [grant][rese
**Precise Expected Outputs when the command fails:**

```
Invalid command format!
edit: Edits the details of the task identified by the index number used in the displayed task list.
Invalid command format!
edit: Edits the details of the task identified by the index number used in the displayed task list.
Existing values will be overwritten by the input values.
Parameters: [index] n/[name] p/[priority] d/[dueDate] t/[tag...] l/[link]
Parameters: [index] n/[name] p/[priority] d/[dueDate] t/[tag...] l/[link]
Example: edit 1 p/4
```

Expand Down Expand Up @@ -601,7 +601,7 @@ Recurring: WEEKLY
 **Precise Expected Outputs when the command fails:**

```
Invalid command format!
Invalid command format!
filter: Filters for tasks with one or more criteria and displays them as a list with index numbers.
Parameters: d/[dueDate] p/[priority] recur/[recur] s/[status]
Example: filter d/01-01-2024 s/done
Expand Down
10 changes: 5 additions & 5 deletions docs/team/yarnmengnus.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,26 +24,26 @@ ProfPlan is a CLI-based task management tool tailored to university professors,
* Credits: Code written for this feature is original.

* **New Feature**: Added significant capabilities to the `help` command [#127](https://github.com/AY2324S1-CS2103T-W15-1/tp/pull/127)
* What it does:
* What it does:
1. Lists all commands and their usage when no arguments supplied
1. Shows more details description and usage of commands when a command is supplied as an argument
* Justification: This feature guides new users to better navigate ProfPlan, instead of diverting users to the user guide. This saves much time for users.
* Credits: Code written for this feature is original.


* **Project management**:
* Responsible for uniformity of the User Guide.
* Responsible for uniformity of the User Guide.
* Contributed to team code reviews while merging ALL PRs.
* Tested release versions for bugs.
* Set up physical meetings for code reviews.
* Assisted in scoping of features in each release.
* Assisted in scoping of features in each release.
* Contributed to milestone and issue categorisation and management.

### 2. Documentation
**User Guide**
* Added documentation for the `help` and `stats` feature [#114](https://github.com/AY2324S1-CS2103T-W15-1/tp/pull/114)
* Added docutmentation for the Link parameter.
* Fixed link functionality
* Fixed link functionality
* Fixed visual bugs in the User Guide.
* In charge of the final formatting and cleaning up.

Expand All @@ -52,7 +52,7 @@ ProfPlan is a CLI-based task management tool tailored to university professors,
* Added detailed documentation for the `stats` command, including an UML sequence diagram. [#234](https://github.com/AY2324S1-CS2103T-W15-1/tp/pull/234)
* Added Use Case for `help`, `stats` and `link` commands. [#63](https://github.com/AY2324S1-CS2103T-W15-1/tp/pull/63)

### Other contributions
### Other contributions
* **Community**:
* Reviewed most PRs from teammates

Expand Down

0 comments on commit eeda817

Please sign in to comment.