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 02-getting-started.md #9530

Closed
wants to merge 1 commit into from

Conversation

bartduisters
Copy link

Rephrase pets to cats, dogs, or rabbits as is done the first time in the guide.

Rephrase `pets` to `cats, dogs, or rabbits` as is done initially.
@zepfietje
Copy link
Member

I think the current docs read a little better.
Feel free to clarify if I'm missing something though.

@zepfietje zepfietje closed this Nov 8, 2023
@zepfietje zepfietje added the documentation Improvements or additions to documentation label Nov 8, 2023
@zepfietje zepfietje added this to the v3 milestone Nov 8, 2023
@bartduisters
Copy link
Author

It's not a big issue, but in the first section of that page there is this sentence:

It will support adding new patients (cats, dogs, or rabbits), assigning them to an owner, and recording which treatments they received.

Which implies to me that a patient will always be either a cat, dog or rabbit.

Later on there is once pets (patients) and once patients (pets). It is clear to me that pets and patients are used as synonyms, but it also made me think that now all of a sudden a patient could be anything, not just a dog, cat or rabbit.

To have it consistent I suggested the change.

Otherwise my suggestion is to keep the order consistent and swap pets (patients) to patients (pets) as well.

If none of the suggestions are applied, that's fine as well. Could just be me that took it too literal.

@zepfietje
Copy link
Member

I think Dan wrote the docs like this initially, since it refers to patients explicitly when talking about the model, while the introduction is more of an explanation of the business logic.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

2 participants