search

input-output-hk / cardano-wallet-legacy

Official Wallet Backend & API for Cardano-SL
https://input-output-hk.github.io/cardano-wallet/
MIT License
21 stars 12 forks source link

Inconsistencies in API doc summary formatting: create vs creates, period vs no period #333

Open Anviking opened 5 years ago

Anviking commented 5 years ago
Release Operating System Cause
next Windows & OSX & Linux) Code

Context

Endpoints are shown in a list of the docs, with individual "summaries" (created with Summary).

Steps to Reproduce

  1. View docs from https://input-output-hk.github.io/cardano-wallet/#tag/Accounts and downwards
  2. Look at the summaries of the endpoints

Expected behavior

Actual behavior

skarmavbild 2019-02-11 kl 13 10 21 skarmavbild 2019-02-11 kl 12 59 42

Resolution Plan

PR

Number Base
#? develop

QA

KtorZ commented 5 years ago

346

piotr-iohk commented 5 years ago

This one appears to be fixed by #346, if I'm not mistaken? If so, I suppose it can be closed.

Anviking commented 5 years ago

Nitpicky, but there is still this

Consistent use of period in summaries

There are some 1-2 word non-endpoint summaries that consistently don't use punctuation. Maybe simplest/safest fix for consistency would be to just enforce punctuation on all endpoints, and ignore the rest. Or… to remove all punctuation. 🤷‍♂️

Plus there is still third person present tense in the node api endpoints. https://github.com/input-output-hk/cardano-sl/pull/4100