Skip to content
This repository has been archived by the owner on Apr 24, 2022. It is now read-only.

Commit

Permalink
[TEAMMATES#11684] Fix minor typos (TEAMMATES#11685)
Browse files Browse the repository at this point in the history
* Fix minor typos

* Remove unnecessary multi-byte characters
  • Loading branch information
samuelfangjw committed Mar 31, 2022
1 parent e1a19ac commit 7dfda8b
Show file tree
Hide file tree
Showing 13 changed files with 18 additions and 19 deletions.
4 changes: 2 additions & 2 deletions docs/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Thanks for taking your time to contribute to TEAMMATES!

We welcome contributions from anyone, in particular, students (see [here](https://teammatesv4.appspot.com/web/front/about) for the list of our contributors). One of the main objectives of TEAMMATES is to help students get experience in an OSS production environment. Here are some information that might be useful to would-be contributors.
We welcome contributions from anyone, in particular, students (see [here](https://teammatesv4.appspot.com/web/front/about) for the list of our contributors). One of the main objectives of TEAMMATES is to help students get experience in an OSS production environment. Here are some information that might be useful to would-be contributors.

* [Getting started](#getting-started)
* [Know the product/project](#know-the-productproject)
Expand Down Expand Up @@ -97,7 +97,7 @@ Try your best to be familiar with at least building and testing the application

#### Phase C: Start contributing

When you are ready for a real contribution, you are advised to start with an issue labelled [good first issue](https://github.com/TEAMMATES/teammates/issues?q=is:issue+is:open+label:"good+first+issue") (but do not do more than one of those), then move on to other issues labelled [help wanted](https://github.com/TEAMMATES/teammates/issues?q=is:issue+is:open+label:"help+wanted").
When you are ready for a real contribution, you are advised to start with an issue labelled [good first issue](https://github.com/TEAMMATES/teammates/issues?q=is:issue+is:open+label:"good+first+issue") (but do not do more than one of those), then move on to other issues labelled [help wanted](https://github.com/TEAMMATES/teammates/issues?q=is:issue+is:open+label:"help+wanted").
Steps for fixing an issue are lined out in the [process document](process.md).

> In the event that you cannot find a `good first issue`-labelled issue, you can start with a `help wanted`-labelled issue.
Expand Down
2 changes: 1 addition & 1 deletion docs/e2e-testing.md
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,7 @@ All Page Object classes inherit from `AppPage` which contains methods that are c

1. **Testing based on implementation** - The focus should be on user actions instead of implementation details. Therefore, black box testing should be adopted and test cases should be designed around use cases.
1. **Excessive exception testing** - Testing edge cases with E2E tests should be avoided. This is because E2E tests are expensive to run and not that effective for isolating bugs. Hence we should focus on the happy path and exception paths that are more common. We should leave more exhaustive testing to lower-level unit or integration tests.
1. **Not following Tell Dont Ask" Principle** - Instead of asking for data from the page objects and performing operations on them, tell the page object to do the operations. This is mostly seen in the verification methods where assertions are done in the page object instead of in the test case. This improves readability and maintainability as data and behavior are placed together.
1. **Not following "Tell Don't Ask" Principle** - Instead of "asking" for data from the page objects and performing operations on them, "tell" the page object to do the operations. This is mostly seen in the verification methods where assertions are done in the page object instead of in the test case. This improves readability and maintainability as data and behavior are placed together.

### FAQ

Expand Down
9 changes: 4 additions & 5 deletions src/main/java/teammates/logic/api/Logic.java
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ public StudentProfileAttributes updateOrCreateStudentProfile(StudentProfileAttri
}

/**
* Deletes both instructor and student privileges, as long as the account and associated student profile.
* Deletes both instructor and student privileges, as well as the account and associated student profile.
*
* <ul>
* <li>Fails silently if no such account.</li>
Expand Down Expand Up @@ -306,7 +306,7 @@ public InstructorAttributes updateInstructor(InstructorAttributes.UpdateOptionsW

/**
* Make the instructor join the course, i.e. associate the Google ID to the instructor.<br>
* Creates an account for the instructor if there is no existing account for him.
* Creates an account for the instructor if no existing account is found.
* Preconditions: <br>
* * Parameters regkey and googleId are non-null.
*/
Expand Down Expand Up @@ -437,7 +437,6 @@ public CourseAttributes updateCourseCascade(CourseAttributes.UpdateOptions updat
* @param courseId The course of which the archive status is to be changed
* @param archiveStatus The archive status to be set
*/

public void setArchiveStatusOfInstructor(String googleId, String courseId, boolean archiveStatus)
throws InvalidParametersException, EntityDoesNotExistException {

Expand Down Expand Up @@ -719,7 +718,7 @@ public StudentAttributes updateStudentCascade(StudentAttributes.UpdateOptions up

/**
* Make the student join the course, i.e. associate the Google ID to the student.<br>
* Create an account for the student if there is no account exist for him.
* Create an account for the student if no existing account is found.
* Preconditions: <br>
* * All parameters are non-null.
* @param key the registration key
Expand Down Expand Up @@ -1421,7 +1420,7 @@ public AccountRequestAttributes createAccountRequest(AccountRequestAttributes ac
*
* @return the updated account request
* @throws InvalidParametersException if the account request is not valid
* @throws EntityDoesNotExistException if the account request does not exist
* @throws EntityDoesNotExistException if the account request to update does not exist
*/
public AccountRequestAttributes updateAccountRequest(AccountRequestAttributes.UpdateOptions updateOptions)
throws InvalidParametersException, EntityDoesNotExistException {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ void initLogicDependencies() {
*
* @return the updated account request
* @throws InvalidParametersException if the account request is not valid
* @throws EntityDoesNotExistException if the account request to create does not exist
* @throws EntityDoesNotExistException if the account request to update does not exist
*/
public AccountRequestAttributes updateAccountRequest(AccountRequestAttributes.UpdateOptions updateOptions)
throws InvalidParametersException, EntityDoesNotExistException {
Expand Down
2 changes: 1 addition & 1 deletion src/main/java/teammates/logic/core/AccountsLogic.java
Original file line number Diff line number Diff line change
Expand Up @@ -240,7 +240,7 @@ void makeAccountInstructor(String googleId) throws InvalidParametersException, E
}

/**
* Deletes both instructor and student privileges, as long as the account and associated student profile.
* Deletes both instructor and student privileges, as well as the account and associated student profile.
*
* <ul>
* <li>Fails silently if no such account.</li>
Expand Down
2 changes: 1 addition & 1 deletion src/main/java/teammates/logic/core/DataBundleLogic.java
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ public static DataBundleLogic inst() {

/**
* Persists data in the given {@link DataBundle} to the database, including
* accounts, courses, instructors, students, sessions, questions, responses, and comments.
* accounts, account requests, courses, instructors, students, sessions, questions, responses, and comments.
*
* <p>Accounts are generated for students and instructors with Google IDs
* if the corresponding accounts are not found in the data bundle.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
import teammates.ui.output.FeedbackSessionData;

/**
* Move the feedback sesion to the recycle bin.
* Move the feedback session to the recycle bin.
*/
class BinFeedbackSessionAction extends Action {

Expand Down
2 changes: 1 addition & 1 deletion src/test/java/teammates/common/util/StringHelperTest.java
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,7 @@ public void testDecryptingInvalidCiphertextThrowsException() {
String invalidHexString = "GHI";

// AES requires the length of data to be multiples of 128 bits.
// Hence, decryptionn should fail for inputs of 120 and 136 bits.
// Hence, decryption should fail for inputs of 120 and 136 bits.
String ciphertextLength120 = "AAAAAAAAAABBBBBBBBBBCCCCCCCCCC";
String ciphertextLength136 = ciphertextLength120 + "1234";

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -283,7 +283,7 @@ export class QuestionEditFormComponent {
if (!this.model.isQuestionHasResponses || !doChangesNeedWarning) {
this.saveExistingQuestionEvent.emit();
} else if (this.model.isFeedbackPathChanged) {
// warn user that editing feedback path will delete all messges
// warn user that editing feedback path will delete all messages
const modalContent: string = `
<p>You seem to have changed the feedback path settings of this question. Please note that changing the
feedback path will cause <b>all existing responses to be deleted.</b> Proceed?</p>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import { Pipe, PipeTransform } from '@angular/core';
/**
* Pipe to handle the transformation of an enum to an array of all types it has.
*
* <p>Assums the enum is string in runtime.
* <p>Assumes the enum is string in runtime.
*/
@Pipe({
name: 'enumToArray',
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ export enum CoursesSectionQuestions {
SIZE_LIMIT = 'size-limit',

/**
* What should I do if my course doesnt have teams?
* What should I do if my course doesn't have teams?
*/
NO_TEAMS = 'no-teams',

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -328,7 +328,7 @@ export class InstructorCourseEditPageComponent implements OnInit {
/**
* The non-null assertion operator (!) is used below in `isDisplayedToStudents`,
* `displayedToStudentsAs` and `role`. These attributes should never be undefined and are only
* typed as such to accomodate for a use case in SearchService.
* typed as such to accommodate for a use case in SearchService.
*/
return {
googleId: i.googleId,
Expand Down
4 changes: 2 additions & 2 deletions src/web/types/sort-properties.ts
Original file line number Diff line number Diff line change
Expand Up @@ -258,7 +258,7 @@ export enum SortBy {
RANK_OPTIONS_OVERALL_RANK,

/**
* Giver's / Recipients's team
* Giver's / Recipient's team
*/
RANK_RECIPIENTS_TEAM,

Expand Down Expand Up @@ -318,7 +318,7 @@ export enum SortBy {
CONSTSUM_OPTIONS_OPTION,

/**
* Option's recieved/total/average points
* Option's received/total/average points
*/
CONSTSUM_OPTIONS_POINTS,

Expand Down

0 comments on commit 7dfda8b

Please sign in to comment.