xrpl-dev-portal icon indicating copy to clipboard operation
xrpl-dev-portal copied to clipboard

Notation for rpc object in Clio server_info response (rpc.*.<>) is hard to read and inconsistent with other reference docs.

Open amarantha-k opened this issue 3 years ago • 0 comments

This issue tracks a suggestion that was deferred on PR #1468: "I find that notation in the style of rpc.*.whatever gets hard to read or mentally parse, so the convention I've been using in the reference docs is to break these out into a separate table below, with the table description saying something like, "The rpc object is a map of API method names to API Stat Objects (see below)." (Better yet—use a link instead of "see below") and then below I have a sub-heading for "API Stats Object" with a table of the fields that (may) appear in each one. See account_nfts for a practical example."

amarantha-k avatar Aug 22 '22 23:08 amarantha-k