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

[REFACTOR] Add and remove not useful person's fields #18

Conversation

WilliamRyank
Copy link

No description provided.

LICENSE Outdated
@@ -6,7 +6,7 @@ Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal

Choose a reason for hiding this comment

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

Just FYI,

  1. 'persons' is a term that can be used in legal writing. This license is legal writing, so it's okay to put it as 'persons'.
  2. Don't change licenses or copyright notices.

Copy link
Author

Choose a reason for hiding this comment

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

i mass changed the word person i think so it changes the license too ill added later

Choose a reason for hiding this comment

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

Noted on this.

@@ -320,8 +320,8 @@ _{More to be added}_

*MSS*

1. User requests to list persons
2. AddressBook shows a list of persons
1. User requests to list people

Choose a reason for hiding this comment

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

It seems that the developer guide is about the Address Book, not our software. Could you update the contents of the developer's guide to be specific to our software?

@@ -34,7 +34,7 @@ e.g. typing *`help`* and pressing kbd:[Enter] will open the help window.
. Some example commands you can try:

* *`list`* : lists all contacts
* **`add`**`n/John Doe p/98765432 e/johnd@example.com a/John street, block 123, #01-01` : adds a contact named `John Doe` to the Address Book.

Choose a reason for hiding this comment

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

While I appreciate the work done, there is no need for you to edit the User Guide as I have drafted a User Guide and made a PR.

@@ -87,19 +80,18 @@ public CommandResult execute(Model model) throws CommandException {
}

/**
* Creates and returns a {@code Person} with the details of {@code personToEdit}
* Creates and returns a {@code person} with the details of {@code personToEdit}

Choose a reason for hiding this comment

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

Instead of {@code person}, it should be {@code Person} because 'Person' is the class name.

@@ -7,9 +7,7 @@

/* Prefix definitions */
public static final Prefix PREFIX_NAME = new Prefix("n/");
public static final Prefix PREFIX_NRIC = new Prefix("ic/");
public static final Prefix PREFIX_PHONE = new Prefix("p/");

Choose a reason for hiding this comment

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

Just a point for discussion, should our prefix be '/c' for Contact, or '/p' for Phone?

@@ -77,7 +77,8 @@ public void addPerson(Person p) {
/**
* Replaces the given person {@code target} in the list with {@code editedPerson}.
* {@code target} must exist in the address book.
* The person identity of {@code editedPerson} must not be the same as another existing person in the address book.
* The person identity of {@code editedPerson} must not be the same as another existing person

Choose a reason for hiding this comment

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

While this comment is informative, perhaps a better way to word it would be 'The identity of {@code editedPerson} should not be the same as another existing {@code Person}'?
Also, the context needs to be changed, because we are changing this from the Address Book to the ORGANice Transplant Manager


public static final String MESSAGE_CONSTRAINTS = "Addresses can take any values, and it should not be blank";
public static final String MESSAGE_CONSTRAINTS = "Nric must be in the form [S/T/F/G][7-numbers][A-Z], "
+ "and it should not be blank";

/*

Choose a reason for hiding this comment

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

Perhaps a better comment would explain the regex on what makes a valid NRIC, such as:

  1. It must start with S, T, F or G
  2. It must have 7 digits afterward
  3. it must end with a letter

@@ -4,7 +4,7 @@
import static seedu.address.commons.util.AppUtil.checkArgument;

/**
* Represents a Person's phone number in the address book.
* Represents a person's phone number in the address book.

Choose a reason for hiding this comment

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

I think this comment should remain as 'Represent a Person's...' instead of 'person'. The reason is that 'Person' represents the class, while 'person' is an English term. This comment is meant to be a technical description of what this class is. In this case, this class represents the phone number of Person objects. Therefore, I think 'Person' is a more apt choice.

}

/**
* Converts this Jackson-friendly adapted person object into the model's {@code Person} object.
* Converts this Jackson-friendly adapted person object into the model's {@code person} object.

Choose a reason for hiding this comment

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

Same issue, 'person' vs 'Person'

import javafx.scene.layout.HBox;
import javafx.scene.layout.Region;
import seedu.address.model.person.Person;

/**
* An UI component that displays information of a {@code Person}.
* An UI component that displays information of a {@code person}.

Choose a reason for hiding this comment

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

Same issue as the 'person'/'Person' issue

@@ -27,7 +27,7 @@ public PersonListPanel(ObservableList<Person> personList) {
}

/**
* Custom {@code ListCell} that displays the graphics of a {@code Person} using a {@code PersonCard}.
* Custom {@code ListCell} that displays the graphics of a {@code person} using a {@code PersonCard}.

Choose a reason for hiding this comment

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

Same issue as the 'person'/'Person' issue

@iskandarzulkarnaien
Copy link

This PR may have an issue with Travis. If need to merge soon, see if creating another PR will work. See #26

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants