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

Double-check and fix ordering of ledger object field tables

Open mDuo13 opened this issue 3 years ago • 0 comments

The Ledger Object Types documentation has parameter tables for each object type, but the ordering of the fields in the table is not consistent.

We should update the tables for all the ledger object types to list the fields in a consistent order. The order we have been using most often is to list required fields in alphabetical order, followed by optional fields in alphabetical order. I've been thinking maybe it would make more sense to put all the fields in alphabetical order (regardless of optionality) since users who are looking up a field in the table after seeing it in an object may not know if the field is required or optional, and having them separated may make it easier to miss the field.

I think the formats returned by the rippled APIs typically put the fields in (case-sensitive) alphabetical order, so that dovetails reasonably well with putting all fields in alphabetical order overall.

mDuo13 avatar Oct 04 '21 22:10 mDuo13