eos icon indicating copy to clipboard operation
eos copied to clipboard

Clarify producer location value type by providing an example: ISO 3166-1 numeric

Open 13rac1 opened this issue 4 years ago • 0 comments

Change Description

The type definition of the producer location unsigned integer is vague.

Relative location for purpose of nearest neighbor scheduling

This change adds ISO 3166-1 numeric as an example value type for the cleos system regproducer location field:

`location` _UINT_ - Relative location for purpose of nearest neighbor scheduling, e.g. ISO 3166-1 numeric

A search of this help text currently returns just the cleos source code or EOSIO documentation itself. The value/use of the location value is chain specific, but an example will clarify usage.

Change Type

Select ONE:

  • [x] Documentation
  • [ ] Stability bug fix
  • [ ] Other
  • [ ] Other - special case

Testing Changes

Select ANY that apply:

  • [ ] New Tests
  • [ ] Existing Tests
  • [ ] Test Framework
  • [ ] CI System
  • [ ] Other

Consensus Changes

  • [ ] Consensus Changes

API Changes

  • [ ] API Changes

Documentation Additions

  • [ ] Documentation Additions

13rac1 avatar Jul 05 '21 18:07 13rac1