Peerplays_Blockchain/peerplays_migrated

Fork 0

Fix API docs generation for map<> and flat_map<> #460

New issue

Closed

opened 2022-10-01 16:09:10 +00:00 by timur.5 · 15 comments

timur.5 commented

2022-10-01 16:09:10 +00:00

(Migrated from gitlab.com)

The JSon syntax for map<> and flat_map<> is not described properly in the generated docs.
For both it is

{a => b, ...}

whereas for map<> it should be:

{a: b, ...}

and for flat_map<>:

[[a, b], ...]

The JSon syntax for map<> and flat_map<> is not described properly in the generated docs. For both it is ``` {a => b, ...} ``` whereas for map<> it should be: ``` {a: b, ...} ``` and for flat_map<>: ``` [[a, b], ...] ```

timur.5 commented

2022-10-01 22:08:30 +00:00

(Migrated from gitlab.com)

changed the description

timur.5 commented

2022-10-01 22:09:06 +00:00

(Migrated from gitlab.com)

changed the description

timur.5 commented

2022-10-01 22:10:08 +00:00

(Migrated from gitlab.com)

changed the description

timur.5 commented

2022-10-01 22:16:36 +00:00

(Migrated from gitlab.com)

!161

timur.5 commented

2022-10-01 22:20:29 +00:00

(Migrated from gitlab.com)

new >>> gethelp update_son
gethelp update_son
...
    sidechain_public_keys ([[sidechain_type, string], ...]): The new set of
        sidechain public keys. The empty string makes it remain the same.
...

Testcase: in cli_wallet, request help for "update_son" command and check suggested syntax for its "sidechain_public_keys" parameter. It should contain no "=>", only square brackets, and be as follows: ``` new >>> gethelp update_son gethelp update_son ... sidechain_public_keys ([[sidechain_type, string], ...]): The new set of sidechain public keys. The empty string makes it remain the same. ... ```

timur.5 commented

2022-10-01 22:23:04 +00:00

(Migrated from gitlab.com)

assigned to @timur.5, @prandnum, and @wsalloum

serkixenos commented

2022-10-02 13:59:04 +00:00

(Migrated from gitlab.com)

@timur.5 Can you combine your work with updates from here https://gitlab.com/PBSA/peerplays/-/issues/450 and https://gitlab.com/PBSA/peerplays/-/commits/update-cli-wallet-docs

timur.5 commented

2022-10-02 21:41:46 +00:00

(Migrated from gitlab.com)

changed the description

timur.5 commented

2022-10-02 21:42:19 +00:00

(Migrated from gitlab.com)

changed the description

timur.5 commented

2022-10-02 21:42:40 +00:00

(Migrated from gitlab.com)

changed the description

timur.5 commented

2022-10-02 21:47:32 +00:00

(Migrated from gitlab.com)

What do you mean by combining?

serkixenos commented

2022-10-03 12:53:17 +00:00

(Migrated from gitlab.com)

To merge everything together.

serkixenos commented

2022-10-03 17:45:02 +00:00

(Migrated from gitlab.com)

Done...

serkixenos commented

2022-10-03 17:48:03 +00:00

(Migrated from gitlab.com)

mentioned in issue #450

wsalloum commented

2022-10-04 11:20:06 +00:00

(Migrated from gitlab.com)

unlocked >>> gethelp update_son
gethelp update_son

Update a SON object owned by the given account.

Command:
    update_son owner_account url block_signing_key sidechain_public_keys
	broadcast

Parameters:
    owner_account (string): The name of the SON's owner account. Also
	accepts the ID of the owner account or the ID of the SON.
    url (string): Same as for create_son. The empty string makes it remain
	the same.
    block_signing_key (string): The new block signing public key. The empty
	string makes it remain the same.
    sidechain_public_keys ({sidechain_type => string, ...}): The new set of
	sidechain public keys. The empty string makes it remain the same.
    broadcast (boolean): true if you wish to broadcast the transaction.

``` unlocked >>> gethelp update_son gethelp update_son Update a SON object owned by the given account. Command: update_son owner_account url block_signing_key sidechain_public_keys broadcast Parameters: owner_account (string): The name of the SON's owner account. Also accepts the ID of the owner account or the ID of the SON. url (string): Same as for create_son. The empty string makes it remain the same. block_signing_key (string): The new block signing public key. The empty string makes it remain the same. sidechain_public_keys ({sidechain_type => string, ...}): The new set of sidechain public keys. The empty string makes it remain the same. broadcast (boolean): true if you wish to broadcast the transaction. ```

wsalloum (Migrated from gitlab.com) closed this issue

2022-10-04 11:31:41 +00:00