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

Malformed descriptions and 'long' description #12

Closed
wridgers opened this issue Nov 10, 2013 · 1 comment · Fixed by #24
Closed

Malformed descriptions and 'long' description #12

wridgers opened this issue Nov 10, 2013 · 1 comment · Fixed by #24

Comments

@wridgers
Copy link
Contributor

Occasionally the description fields are malformed. This stems from the XML -> JSON conversion since occasionally the description XML fields contain inline HTML. The best solution would be to strip out HTML before converting to JSON.

Further, currently the docs only display the 'short' description field. It would appear that 95% of the documentation only has a 'short' description, but I have come across a few 'long' description fields. It would be good to include these.

@tinne
Copy link
Contributor

tinne commented Mar 30, 2018

  1. At least all text nodes in the short description must be rendered.
  2. Better yet, the long descriptions should follow, although this could be weighted against performance (cf. Search index is very slow #3)
  3. Furthermore, there are value fields to enumerations (like the PhotoShop ColorModel constants), which are part of the JSON, but missing from the HTML output. They could be part of the field divisions, as in

int GRAYSCALE = 1

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

Successfully merging a pull request may close this issue.

2 participants