dhmit / gender_analysis

A toolkit for analyzing gendered language across sets of documents
BSD 3-Clause "New" or "Revised" License
11 stars 5 forks source link

Quickstart guide #154

Closed samimak37 closed 3 years ago

samimak37 commented 3 years ago

This PR builds off of #151 and the sphinx_docs branch.

Transfers all of the Quick Start Guide documentation from the original Google Doc into .rst files such that it can be parsed by Sphinx.

Docstrings on various functions have also been changed in an effort to make navigation and linking easier for readers.

codecov-io commented 3 years ago

Codecov Report

Merging #154 (cfdac50) into master (711a51e) will decrease coverage by 0.02%. The diff coverage is 100.00%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master     #154      +/-   ##
==========================================
- Coverage   56.40%   56.37%   -0.03%     
==========================================
  Files          12       12              
  Lines        1468     1467       -1     
  Branches      362      362              
==========================================
- Hits          828      827       -1     
  Misses        586      586              
  Partials       54       54              
Impacted Files Coverage Δ
corpus_analysis/document.py 84.88% <ø> (ø)
corpus_analysis/metadata_visualizations.py 84.21% <ø> (ø)
gender_analysis/analysis/__init__.py 100.00% <ø> (ø)
gender_analysis/analysis/dunning.py 30.00% <ø> (ø)
gender_analysis/analysis/gender_adjective.py 45.27% <ø> (ø)
gender_analysis/analysis/gender_frequency.py 59.33% <ø> (ø)
gender_analysis/analysis/instance_distance.py 32.60% <ø> (ø)
corpus_analysis/corpus.py 68.05% <100.00%> (ø)

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 711a51e...cfdac50. Read the comment docs.

codecov-commenter commented 3 years ago

Codecov Report

Merging #154 (c6b6688) into master (6850583) will increase coverage by 3.04%. The diff coverage is 100.00%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master     #154      +/-   ##
==========================================
+ Coverage   57.59%   60.64%   +3.04%     
==========================================
  Files          11       13       +2     
  Lines        1408     1649     +241     
  Branches      355      436      +81     
==========================================
+ Hits          811     1000     +189     
- Misses        543      575      +32     
- Partials       54       74      +20     
Impacted Files Coverage Δ
corpus_analysis/corpus.py 68.05% <ø> (ø)
corpus_analysis/metadata_visualizations.py 84.21% <ø> (ø)
gender_analysis/analysis/gender_adjective.py 45.54% <ø> (ø)
gender_analysis/analysis/gender_frequency.py 59.33% <ø> (ø)
gender_analysis/analysis/instance_distance.py 32.60% <ø> (ø)
corpus_analysis/document.py 84.48% <100.00%> (-0.41%) :arrow_down:
gender_analysis/analysis/proximity.py 78.63% <0.00%> (ø)
corpus_analysis/character.py 78.94% <0.00%> (ø)

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 6850583...c6b6688. Read the comment docs.