-
-
Notifications
You must be signed in to change notification settings - Fork 1.6k
fixed typo in developer-docs #1993
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
Merged
Merged
Changes from 1 commit
Commits
Show all changes
11 commits
Select commit
Hold shift + click to select a range
db12be0
fixed typo in developer-docs
ktsrivastava29 f5a83d2
updating "transpile" to "transpiling"
raclim 2743485
maintain original phrasing
raclim df29fbc
update phrasing for proposed extensions
raclim 832c74f
update phrasing within testing documentation
raclim 446f8ce
change back "nobody" to "no body"
raclim 5aa8c82
Revert "nobody" to "no body"
raclim e1b3358
remove package-lock.json changes
raclim 91cca02
add back package-lock.json file
dd939b7
update wording for translations doc
1129cb9
change back to original package-lock.json file
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,12 +1,12 @@ | ||
| # Proposed Public API extensions | ||
|
|
||
| This describes proposed extensions to the Public API. None of these extensions are confirmed, but are recorded here for reference and discussion. | ||
| This describes proposed extensions to the Public API. None of these extensions is confirmed but is recorded here for reference and discussion. | ||
|
||
|
|
||
| Refer to [Public API](./public_api.md) for the current version of the API. | ||
|
|
||
| # Authentication | ||
|
|
||
| - Support for sending tokens can via the `Authorization: Bearer {your_access_token}` HTTP header instead of just Basic Auth | ||
| - Support for sending tokens can be via the `Authorization: Bearer {your_access_token}` HTTP header instead of just Basic Auth | ||
|
|
||
| # API Access | ||
|
|
||
|
|
@@ -22,7 +22,7 @@ Refer to [Public API](./public_api.md) for the current version of the API. | |
| Fetch a sketch. | ||
|
|
||
| ### Request format | ||
| No body. | ||
| Nobody. | ||
|
|
||
| ### Response format | ||
| Returns `Sketch`. | ||
|
|
@@ -56,7 +56,7 @@ Replace the sketch with an entirely new one, maintaining the same ID. Any existi | |
| See `Sketch` in Models above. | ||
|
|
||
| ### Response format | ||
| No body. | ||
| Nobody. | ||
|
|
||
| ### Example | ||
|
|
||
|
|
@@ -90,7 +90,7 @@ Update the sketch whilst maintaining existing data: | |
| See `Sketch` in Models above. | ||
|
|
||
| ### Response format | ||
| No body. | ||
| Nobody. | ||
|
|
||
| ### Example | ||
| Change the name of the sketch | ||
|
|
@@ -131,7 +131,7 @@ Files within a sketch can be individually accessed via their `path` e.g. `data/s | |
| Fetch the contents of a file. | ||
|
|
||
| ### Request format | ||
| No body. | ||
| Nobody. | ||
|
|
||
| ### Response format | ||
| Returns file contents. | ||
|
|
@@ -154,15 +154,15 @@ Returns file contents. | |
|
|
||
| ## `PATCH /:user/sketches/:id/files/:path` | ||
|
|
||
| Update the name or contents a file or directory. | ||
| Update the name or contents of a file or directory. | ||
|
|
||
| ### Request format | ||
| See `File` and `Directory` above. | ||
|
|
||
| ### Response format | ||
| No body. | ||
| Nobody. | ||
|
|
||
| ### Example: Change file name | ||
| ### Example: Change the file name | ||
|
|
||
| PATCH /p5/sketches/Ckhf0APpg/files/assets/something.js | ||
|
|
||
|
|
@@ -206,13 +206,13 @@ Files are added to the directory, in addition to what is there. | |
|
|
||
| ## `DELETE /:user/:sketches/files/:path` | ||
|
|
||
| Delete a file/directory, and it’s contents. | ||
| Delete a file/directory, and its contents. | ||
|
|
||
| ### Request format | ||
| No body. | ||
| Nobody. | ||
|
|
||
| ### Response format | ||
| No body. | ||
| Nobody. | ||
|
|
||
| ### Example: Delete file | ||
|
|
||
|
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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 think 'transpiling' makes sense here, but could also see this sentence as a whole being rephrased as well!