-
Notifications
You must be signed in to change notification settings - Fork 59
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
Edited typos in README #16
base: master
Are you sure you want to change the base?
Conversation
timbolaj
commented
Oct 3, 2020
- Edited typos in README file.
If you choose to accept this PR, would it be possible for you to add the topic of hacktoberfest to this repo? That way, this PR will count towards my contributions. |
There's no need to add any topic to this repository for your PR to count in Hacktoberfest. See the rules. |
Regarding the proposed changes: none of the issues you corrected is a mere typo, i.e. an unintentional typing error. Although I'm a non-native English speaker, well aware of the limits of my language skills, I consider the text as it is (without your changes applied) grammar-wise better than the proposed corrected version. Please prove me wrong if you know I'm not right and want to have the PR merged. |
README.md
Outdated
@@ -2,16 +2,16 @@ | |||
|
|||
[![Build Status](https://travis-ci.org/igneus/church-calendar-api.svg?branch=master)](https://travis-ci.org/igneus/church-calendar-api) | |||
|
|||
Browse Roman Catholic liturgical calendar through a web interface | |||
or obtain it's data in JSON format through an API. | |||
Browse the Roman Catholic liturgical calendar through a web interface |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I suggested the definite article here because it is specific kind of calendar (there is only one liturgical calendar, that which the Vatican has approved).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
there is only one liturgical calendar, that which the Vatican has approved
There are many Roman Catholic liturgical calendars (General Roman Calendar, calendars of nations, provinces, dioceses, religious orders and their provinces and houses, calendars of single churches, ...) and the API can provide access to many of them, so I'm not sure that the definite article is appropriate here.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ah okay, in that case, it should be 'Roman Catholic Liturgical calendars', plural and without the definite article.
Browse Roman Catholic liturgical calendar through a web interface | ||
or obtain it's data in JSON format through an API. | ||
Browse the Roman Catholic liturgical calendar through a web interface | ||
or obtain its data in JSON format through an API. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It's is a contraction of the two words 'it is'. Thus the original could be reread as 'or obtain it is data in JSON format through an API'.
Its on the other hand suggests possession/ownership.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is something I've been writing the wrong way my whole life. Thanks.
README.md
Outdated
|
||
Powered by | ||
[calendarium-romanum][caro] and | ||
grape. | ||
|
||
## Explore it on-line | ||
## Explore it online |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is only a minor point. Both are legitimate - that said, at least here in Canada, we seldom see it written as 'on-line'
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I know it's rare nowadays, but I prefer the (now perceived as mildly archaic) dashed form.
README.md
Outdated
|
||
Church Calendar API is a more or less RESTful read-only JSON API. | ||
Church Calendar API is more or less a RESTful read-only JSON API. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Another minor point. Colloquially, the placement of 'a' could come before or after the expression more or less. Rereading it a second time, the only thing I would modify grammar-wise is adding a comma, but I don't think that would be necessary for a README.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I must admit it's been 10+ years since I was subject to thorough English language drills for the last time, so I may be wrong here, but I don't think the meaning of the two text versions is identical:
Church Calendar API is a more or less RESTful read-only JSON API.
Here the adverbs "more or less" modify just the adjective "RESTful", which is exactly what I wanted to say: the RESTful nature of the API could be disputed and I'm aware of that.
Church Calendar API is more or less a RESTful read-only JSON API.
Here the adverbs "more or less" modify the whole expression "RESTful read-only JSON API", which is not what I wanted to say. Church Calendar API is a "read-only JSON API" - not just "more or less", but 100%. It's just "more or less" RESTful.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I see, then with that context, I withdraw my proposed change for this line.
It turns out they recently changed the rules in response to wide criticism, but the change is not yet reflected on the event's website. So I added the "hacktoberfest" topic. |