Skip to content
This repository has been archived by the owner on Mar 1, 2019. It is now read-only.

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

Open
Anviking opened this issue Feb 11, 2019 · 3 comments
Labels
BUG Something isn't working

Comments

@Anviking
Copy link
Member

Anviking commented Feb 11, 2019

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

  • Consistent use of either "Create [a wallet]" and "Creates [a wallet]" in summaries (Note: the verb "create", is only an example here)
  • Consistent use of period in summaries

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

@Anviking Anviking added the BUG Something isn't working label Feb 11, 2019
@KtorZ
Copy link
Contributor

KtorZ commented Feb 18, 2019

#346

@piotr-iohk
Copy link
Contributor

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

@Anviking
Copy link
Member Author

Anviking commented Feb 27, 2019

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. input-output-hk/cardano-sl#4100

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
BUG Something isn't working
Projects
None yet
Development

No branches or pull requests

3 participants