Skip to content

minor ambiguities in JSON encoding steps #38

@sheppard

Description

@sheppard

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"?

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions