Skip to content
This repository was archived by the owner on Nov 7, 2018. It is now read-only.

Edited the .md files #319

Open
wants to merge 4 commits into
base: dev
Choose a base branch
from
Open

Edited the .md files #319

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
a4ff908
Edited API.md
noodle-eater Nov 2, 2016
842d857
Edited CONTRIBUTING.md
noodle-eater Nov 2, 2016
7f30702
Edited INSTALL.md
noodle-eater Nov 2, 2016
bb362de
Edited README.md
noodle-eater Nov 2, 2016
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
6 changes: 3 additions & 3 deletions API.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ In this query URL:
* `.json` is the Format. Note the dot between the Endpoint and Format. Also note that, since JSON is the default output format, we didn't _have_ to specify it.
* In keeping with standard [URI Query String syntax](https://en.wikipedia.org/wiki/Query_string), the `?` and `&` characters are used to begin and separate the list of query parameters.
* `school.degrees_awarded.predominant=2,3` is a Field Parameter. In this case, it's searching for records which have a `school.degrees_awarded.predominant` value of either `2` or `3`.
* `_fields=id,school.name,2013.student.size` is an Option Parameter, as denoted by the initial underscore character. `_fields` is used to limit the output fields to those in the given list. We strongly recommend using the `_fields` parameter to reduce the amount of data returned by the API, thus increasing performance.
* `_fields=id, school.name, 2013.student.size` is an Option Parameter, as denoted by the initial underscore character. `_fields` is used to limit the output fields to those in the given list. We strongly recommend using the `_fields` parameter to reduce the amount of data returned by the API, thus increasing performance.

### JSON Output Example

Expand Down Expand Up @@ -89,7 +89,7 @@ A successful query will return a JSON with two top-level elements:

### Error Example

Let's change the query so as to generate an error when it's executed:
Let's change the query to generate an error when it's executed:

```
https://api.data.gov/ed/collegescorecard/v1/schools.json?school.degrees_awarded.predominant=frog&_fields=id,school.name,wombat
Expand Down Expand Up @@ -187,7 +187,7 @@ You can perform extra refinement and organisation of search results using **opti

### Limiting Returned Fields with `_fields`

By default, records returned in the query response include all their stored fields. However, you can limit the fields returned with the `_fields` option parameter. This parameter takes a comma-separated list of field names. For example: `_fields=id,school.name,school.state` will return result records that only contain those three fields.
By default, records returned in the query response include all their stored fields. However, you can limit the fields returned with the `_fields` option parameter. This parameter takes a comma-separated list of field names. For example: `_fields=id, school.name, school.state` will return result records that only contain those three fields.

Requesting specific fields in the response will significantly improve performance and reduce JSON traffic, and is recommended.

Expand Down
7 changes: 4 additions & 3 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,8 @@ To run all the tests:

Treat commit messages as an email message that describes what you changed and why.

The first line of the commit log must be treated as as an email
The first line of the commit log
Copy link

Choose a reason for hiding this comment

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

I think the current text was better than your modification, here.

It could be simplified to:

The first line of the commit log is the email subject.

That removes line being repeated, and strictly speaking the email subject line must have the prefix Subject: , which is not needed in the commit log first line.

Copy link
Author

Choose a reason for hiding this comment

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

@jayvdb thanks for the correction.

as an email
subject line. It must be strictly no greater than 50 characters long.
The subject must stand on its own and not only make external
references such as to relevant bug numbers.
Expand Down Expand Up @@ -90,7 +91,7 @@ chances of your issue being dealt with quickly:
* **Motivation for or Use Case** - explain why this is a bug for you
* **Version(s)** - is it a regression?
* **Browsers and Operating System** - is this a problem with all browsers or only IE8?
* **Reproduce the error** - provide a live example, screenshot, and/or a unambiguous set of steps. The more the better.
* **Reproduce the error** - provide a live example, screenshot, and/or an unambiguous set of steps. The more the better.
* **Related issues** - has a similar issue been reported before? Reference the related issues in the descrioption.
* **Suggest a Fix** - if you can't fix the bug yourself, perhaps you can point to what might be
causing the problem (line of code or commit). If you're requesting a feature, describe how the feature might work to resolve the user story.
Expand Down Expand Up @@ -182,6 +183,6 @@ Anyone who reviews a pull request should leave a note to let others know that
someone has looked at it. For larger commits, we like to have a +1 from someone
else on the core team and/or from other contributor(s). Please note if you
reviewed the code or tested locally -- a +1 by itself will typically be
interpreted as your thinking its a good idea, but not having reviewed in detail.
interpreted as your thinking it's a good idea, but not having reviewed in detail.

[Google Group]: https://groups.google.com/d/forum/open-data-maker
2 changes: 1 addition & 1 deletion INSTALL.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
If you just want to install and run, then you can just download a
[zip file](https://github.com/18F/open-data-maker/archive/master.zip).

You will still need the the dependencies below, but you don't need to
You will still need the dependencies below, but you don't need to
clone the git repo for the source code.

## Install Prerequisites
Expand Down
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ Here's how it might look in the future:
![Download all the data or make choices to create a csv with a subset](/doc/csv-download.png)

### Acknowledgements
Zipcode latitude and longitude provided by [GeoNames](http://www.geonames.org/) under under a [Creative Commons Attribution 3.0 License](http://creativecommons.org/licenses/by/3.0/).
Zipcode latitude and longitude provided by [GeoNames](http://www.geonames.org/) under a [Creative Commons Attribution 3.0 License](http://creativecommons.org/licenses/by/3.0/).

### Public domain

Expand Down