Bug 988119 - Our API documentation uses Python specific names for data types, instead of JSON types
Summary: Our API documentation uses Python specific names for data types, instead of J...
Keywords:
Status: CLOSED CURRENTRELEASE
Alias: None
Product: Pulp
Classification: Retired
Component: documentation
Version: Master
Hardware: Unspecified
OS: Unspecified
low
low
Target Milestone: ---
: 2.3.0
Assignee: Barnaby Court
QA Contact: Preethi Thomas
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2013-07-24 18:54 UTC by Randy Barlow
Modified: 2013-12-09 14:30 UTC (History)
3 users (show)

Fixed In Version:
Doc Type: Bug Fix
Doc Text:
Clone Of:
Environment:
Last Closed: 2013-12-09 14:30:55 UTC
Embargoed:


Attachments (Terms of Use)

Description Randy Barlow 2013-07-24 18:54:42 UTC
I've noticed that we talk about "dictionaries" and "lists" in our documentation, which makes sense to us since we are a Python project. However, our API users might not always be working in a Python environment, and we are dealing in JSON across the wire, so it would be good for us to use JSON type names[0], such as object and array (instead of dictionary and list).

We should audit our API docs for these words and replace the usage of them so that our users will have an easier time understanding which data types we are referring to.

[0] http://en.wikipedia.org/wiki/JSON#Data_types.2C_syntax_and_example

Comment 1 Barnaby Court 2013-09-26 19:46:06 UTC
Pull Request: https://github.com/pulp/pulp/pull/637

Comment 2 Jeff Ortel 2013-09-26 20:54:18 UTC
build: 2.3.0-0.16.alpha

Comment 3 Preethi Thomas 2013-10-04 19:07:12 UTC
verified

Comment 4 Preethi Thomas 2013-12-09 14:30:55 UTC
Pulp 2.3 released.


Note You need to log in before you can comment on or make changes to this bug.