New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[MRG] update documentation version #598

Merged
merged 2 commits into from Jan 4, 2019

Conversation

Projects
None yet
2 participants
@ctb
Copy link
Member

ctb commented Jan 4, 2019

While digging into #597 I noticed that the documentation version is out of whack. This fixes that by at least making it clear that the documentation is for a later version than 2.0a1.

@luizirber I'm not really sure how to do this properly in the general case. Yet another reason we shouldn't be doing what we're doing with 2.0.0aXX.

  • Is it mergeable?
  • make test Did it pass the tests?
  • make coverage Is the new code covered?
  • Did it change the command-line interface? Only additions are allowed
    without a major version increment. Changing file formats also requires a
    major version number increment.
  • Was a spellchecker run on the source code and documentation after
    changes were made?
@codecov

This comment has been minimized.

Copy link

codecov bot commented Jan 4, 2019

Codecov Report

Merging #598 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #598   +/-   ##
=======================================
  Coverage   88.64%   88.64%           
=======================================
  Files          25       25           
  Lines        3786     3786           
  Branches       37       37           
=======================================
  Hits         3356     3356           
  Misses        430      430

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 82fb36e...2cde3a9. Read the comment docs.

@luizirber

This comment has been minimized.

Copy link
Member

luizirber commented Jan 4, 2019

We can integrate setuptools_scm here too, so we never need to update it manually: https://github.com/pypa/setuptools_scm#usage-from-sphinx

@luizirber

This comment has been minimized.

Copy link
Member

luizirber commented Jan 4, 2019

I ended up pushing a new branch, do you want me to use this PR instead?
https://github.com/dib-lab/sourmash/compare/docs/version_scm

@ctb

This comment has been minimized.

Copy link
Member

ctb commented Jan 4, 2019

@luizirber

This comment has been minimized.

Copy link
Member

luizirber commented Jan 4, 2019

I added the commit here, so I guess now it's up to you to review the PR? =P

@ctb

This comment has been minimized.

Copy link
Member

ctb commented Jan 4, 2019

huh. it's not letting me review it :). I think we're good, can you squash and merge as admin?

@luizirber luizirber changed the title [WIP] update documentation version [MRG] update documentation version Jan 4, 2019

@luizirber luizirber merged commit ef626e7 into master Jan 4, 2019

2 checks passed

codecov/patch Coverage not affected when comparing 82fb36e...2cde3a9
Details
codecov/project 88.64% remains the same compared to 82fb36e
Details

@luizirber luizirber deleted the update/docs_version branch Jan 4, 2019

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment