jazzband / tablib

Python Module for Tabular Datasets in XLS, CSV, JSON, YAML, &c.
https://tablib.readthedocs.io/
MIT License
4.61k stars 593 forks source link

Moved format documentation from code to docs #420

Closed claudep closed 4 years ago

claudep commented 4 years ago

@hugovk What do you think about this proposal patch? I prefer having an explicit help page rather than counting on automatic API, but it can be a matter of taste.

codecov[bot] commented 4 years ago

Codecov Report

Merging #420 into master will increase coverage by 0.32%. The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master     #420      +/-   ##
==========================================
+ Coverage   89.08%   89.41%   +0.32%     
==========================================
  Files          24       24              
  Lines        2482     2446      -36     
==========================================
- Hits         2211     2187      -24     
+ Misses        271      259      -12
Impacted Files Coverage Δ
src/tablib/core.py 82.78% <ø> (+1.26%) :arrow_up:

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update f1046cd...db51a3e. Read the comment docs.

hugovk commented 4 years ago

👍🏼

Auto docs can often be a little lacking, so explicit docs are often better. Just need to remember to update them as the code changes.