- Notifications
You must be signed in to change notification settings - Fork1.1k
Clarify instructions for /forks endpoint.#828
Uh oh!
There was an error while loading.Please reload this page.
Conversation
The existing text isn't clear as to whether the `organization` parameter is optional. This can lead to people assuming the parameter isn't optional and doing `organization=username`, which will not work.
jasonrudolph commentedJul 25, 2015
@jammur: Thanks for this pull request. 🙇 The existing docs for this endpoint are a little unusual when compared to the rest of the API docs. I think thatmight be contributing to some of the confusion. I'll try to explain and also propose a remedy. For most of the API endpoints, the docs describe each parameter inside the "Parameters" table. For example, consider thedocs for the "Create a file" endpoint:
It's kind of strange that the"Create a fork" docs describe the parameter in freeform proseand also in the "Parameters" table:
While we're updating these docs, I recommend addressing that anomaly like so:
What do you think? |
This removes the freeform prose from the /forks endpoint description, and clarifies the `organization` parameter in the parameters table.
jammur commentedJul 26, 2015
@jasonrudolph Thanks for the feedback! I agree. I've pushed a new commit with your suggested changes. |
Clarify instructions for /forks endpoint.
jasonrudolph commentedJul 27, 2015
🍰 |
The existing text isn't clear as to whether the
organizationparameter is optional. This can lead to people assuming the parameter isn't optional and doingorganization=username, which will not work.