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.

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

minor ambiguities in JSON encoding steps #38

Open
sheppard opened this issue Mar 20, 2015 · 0 comments
Open

minor ambiguities in JSON encoding steps #38

sheppard opened this issue Mar 20, 2015 · 0 comments

Comments

@sheppard
Copy link

We're working on implementing this spec in Python (see encode/django-rest-framework#2148 and encode/django-rest-framework#2682).

Overall I found everything to be very straightforward and well-documented, though I did come across a few minor misspellings and ambiguities in the steps to set a JSON encoding value:

  • 8.1.1/8.1.2: Does "return it" refer to the context or to the newly created array/object? (The implementation suggests that "it" refers to the new object, but it would be helpful if this was more explicit)
  • 8.3: rub -> run
  • 8.3.3: The "Otherwise" seems out of place - it appears this action should always happen whenever step 8.3 is reached. (At first I thought 8.3.3 was an "else" for the "if item is not undefined then..." clause in 8.3.2)

Another minor spelling question is in Example 4 - should "hearbeat" be "heartbeat"?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant