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.

Sign up for GitHub

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

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Edited typos in README #16

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
943b163
Edited typos
timbolaj Oct 3, 2020
0408bee
modified to fit review comments
timbolaj Oct 4, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Copy link
Author

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).

For ref: https://owl.purdue.edu/owl/general_writing/grammar/using_articles.html#:~:text=The%20definite%20article%20is%20used,the%20dog%20that%20bit%20me.

Copy link
Owner

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.

Copy link
Author

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.

or obtain its data in JSON format through an API.
Copy link
Author

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.

Copy link
Owner

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.


Powered by
[calendarium-romanum][caro] and
grape.

## Explore it on-line
## Explore it online
Copy link
Author

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'

Copy link
Owner

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.


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.
Copy link
Author

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.

Copy link
Owner

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.

Copy link
Author

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.


API documentation with URI examples and live links to API endpoints:
http://calapi.inadiutorium.cz/api-doc
Expand Down