briancurtin / deprecation

A library to handle automated deprecations
Apache License 2.0
88 stars 31 forks source link

Add a docstring for message_location #16

Closed briancurtin closed 6 years ago

briancurtin commented 6 years ago

This change adds an explanation of what message_location can do.

briancurtin commented 6 years ago

@kmuehlbauer can you take a quick look at this? I just realized that message_location wasn't showing up in the docs so this adds it. After this one I'll make the release.

briancurtin commented 6 years ago

It also slightly changed __all__ so message_location showed up closer to the decorator in the docs.

codecov-io commented 6 years ago

Codecov Report

Merging #16 into master will not change coverage. The diff coverage is 100%.

Impacted file tree graph

@@          Coverage Diff          @@
##           master    #16   +/-   ##
=====================================
  Coverage     100%   100%           
=====================================
  Files           1      1           
  Lines          83     83           
  Branches       16     16           
=====================================
  Hits           83     83
Impacted Files Coverage Δ
deprecation.py 100% <100%> (ø) :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 bad89de...aa4a7b9. Read the comment docs.

kmuehlbauer commented 6 years ago

This looks good, but how will this effect the docs? I just sphinxed this, but had nothing in the docs. Maybe I did something wrong while sphinxing.

kmuehlbauer commented 6 years ago

@briancurtin My bad. Problem sit's in front of screen. All good! :+1:

briancurtin commented 6 years ago

Hah! Thanks, I'll put together the release and comment back here when it's done.

briancurtin commented 6 years ago

@kmuehlbauer there you go: https://pypi.org/project/deprecation/2.0/

Thanks for your help on all of this stuff!

kmuehlbauer commented 6 years ago

@briancurtin Perfect! No worries, deprecation-package is a replacement for one decorator we had in our codebase. But much nicer. Glad, we got this running.

kmuehlbauer commented 6 years ago

BTW, we have deprecation packaged within conda-forge.

briancurtin commented 6 years ago

Oh cool! :beers: