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

Some of the API documentation is difficult to read #241

Closed
tomschenkjr opened this issue Aug 16, 2016 · 2 comments
Closed

Some of the API documentation is difficult to read #241

tomschenkjr opened this issue Aug 16, 2016 · 2 comments
Assignees

Comments

@tomschenkjr
Copy link
Contributor

tomschenkjr commented Aug 16, 2016

Some of the formatting is pretty difficult to read. See this example from http://opengrid.readthedocs.io/en/latest/OpenGrid%20API/#113-users
image

Might want to switch to a format like this API docs.

@seancarroll
Copy link

seancarroll commented Dec 14, 2016

Currently a code block (<code></code> ) is being used. Instead how about using '''json? Example provided below

[
  {
    "id": "speed_camera_locations",
    "displayName": "Speed Camera Locations",
    "options": {
      "rendition": {
        "icon": "default",
        "color": "cyan",
        "fillColor": "#f03",
        "opacity": 80,
        "size": 10
      },
      "latLong": "latitude,longitude",
      "creationTimestamp": null,
      "defaultSort": null,
      "lat": "latitude",
      "long": "longitude"
  }
]

@seancarroll
Copy link

Just looked at the dev branch and it already has been updated to use ``` code fence

@tomschenkjr tomschenkjr added this to the v1.3.0 milestone Dec 15, 2016
@PriyaDoIT PriyaDoIT removed this from the v1.3.0 milestone Jan 24, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants