Project

General

Profile

Misc #14581

Update JSON docs

Added by zverok (Victor Shepelev) over 1 year ago. Updated over 1 year ago.

Status:
Third Party's Issue
Priority:
Normal
Assignee:
-
[ruby-core:85954]

Description

What is here:

  • adding docs for (questionable, yet present) "additions" feature;
  • cleaning up (both formatting and formulations) docs of JSON.generate: current docs are poorly formatted and its documentation shifted more towards (internal) State object than just options;
  • some other style/formatting cleanups.

Files

json-docs.patch (5.67 KB) json-docs.patch zverok (Victor Shepelev), 03/06/2018 09:14 PM

History

#1

Updated by zverok (Victor Shepelev) over 1 year ago

  • Description updated (diff)

Updated by hsbt (Hiroshi SHIBATA) over 1 year ago

  • Status changed from Open to Third Party's Issue

Can you submit an upstream repository first?

https://github.com/flori/json

Updated by zverok (Victor Shepelev) over 1 year ago

hsbt (Hiroshi SHIBATA) Ah, OK. I've tried to find the "upstream" version but failed to do so. Thanks for pointing it out.

Updated by zverok (Victor Shepelev) over 1 year ago

hsbt (Hiroshi SHIBATA) BTW, what's the maintenance status of the upstream? Currently, I can see there:

  • the last PR is merged in October, last before that in Jun, last before that in spring, there are several uncommented PRs (including ones with serious performance improvements, or security issue discussion/PR open for 3 years in a row)
  • there are a lot of unaddressed issues, and of closed ones, the last that was touched by repo owner was just silent closing (of irrelevant ones?) in April

I was thinking about doing several PRs to clean up the legacy parts of the library & docs, but now I am not sure if there would be anybody on the receiving end of those PRs.

Updated by zverok (Victor Shepelev) over 1 year ago

(In addition, as far as I understand, there is some discrepancy between "standalone" json and in-Ruby json: the latter does not include "pure" part of JSON library, virtually rendering half of its code and docs false.)

Updated by hsbt (Hiroshi SHIBATA) over 1 year ago

what's the maintenance status of the upstream?

It's active.

Also available in: Atom PDF