api documentation tests #58

zkat · 2017-03-09T10:10:48Z

This makes sure that all toplevel api functions have a corresponding entry in README.md. It's a pretty basic test for now, but can be expanded later.

# Subtest: all toplevel api calls are documented
    # [ 'extract', 'manifest', 'prefetch' ]
    ok 1 - pacote.extract has a docs entry
    ok 2 - pacote.manifest has a docs entry
    ok 3 - pacote.prefetch has a docs entry
    1..3
ok 2 - all toplevel api calls are documented # time=146.214ms

zkat · 2017-03-09T18:54:01Z

It makes literally no sense to me that this dropped code coverage lol

@isaacs

This allows us to avoid hitting the registry repeatedly to get the same packument multiple times when we are resolving many different specifiers for the same package name. Even though these requests are cached after the first hit, just pinging the registry with an ETag and getting a 304 response still adds up to quite a bit of time waiting on network requests to complete. PR-URL: npm/pacote#58 Credit: @isaacs Close: zkat#58 Reviewed-by: @wraithgar

zkat added 2 commits March 9, 2017 01:42

chore(docs): converted to new style

c3dc481

chore(tests): added test to verify api fns documented

3b2facd

zkat added documentation tests labels Mar 9, 2017

zkat added this to the 1.0.0 milestone Mar 9, 2017

zkat requested a review from varjmes March 9, 2017 10:10

zkat merged commit 7142eb4 into latest Mar 9, 2017

zkat deleted the zkat/doctests branch March 9, 2017 18:54

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

api documentation tests #58

api documentation tests #58

zkat commented Mar 9, 2017 •

edited

Loading

zkat commented Mar 9, 2017

api documentation tests #58

api documentation tests #58

Conversation

zkat commented Mar 9, 2017 • edited Loading

zkat commented Mar 9, 2017

zkat commented Mar 9, 2017 •

edited

Loading