Skip to content
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

DOC: Update readme to reflect current output of duecredit summary #89

Merged
merged 3 commits into from
May 26, 2016

Conversation

mvdoc
Copy link
Member

@mvdoc mvdoc commented May 25, 2016

So pretty! ;-)


1 package cited
0 modules cited
1 function cited
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wondered now if we should add 1 more:
x citable modules were imported but no citable functionality was used ;-)

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

mmmh, I'm not really enthusiastic about it ;p isn't the whole idea of tags to reduce the noise? we could have another command like duecredit stats that provides some stats?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Well we are providing stats already... I just thought it might come handy to inform user that some modules were possibly used but not listed

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

But ok, we can leave it for later

@coveralls
Copy link

coveralls commented May 25, 2016

Coverage Status

Coverage remained the same at 87.848% when pulling e731510 on mvdoc:updatereadme into d76728c on duecredit:master.

@codecov-io
Copy link

codecov-io commented May 25, 2016

Current coverage is 84.09%

Merging #89 into master will decrease coverage by 0.45%

@@             master        #89   diff @@
==========================================
  Files            46         46          
  Lines          2253       2187    -66   
  Methods           0          0          
  Messages          0          0          
  Branches        249        251     +2   
==========================================
- Hits           1905       1839    -66   
  Misses          266        266          
  Partials         82         82          

Powered by Codecov. Last updated by 8b05155...e731510

@yarikoptic
Copy link
Member

This one is not affected by the fix in #88 right?

@mvdoc
Copy link
Member Author

mvdoc commented May 26, 2016

yes it is. good point.

@yarikoptic
Copy link
Member

ok -- review/merge #90, adjust this one, we will merge and release!

@coveralls
Copy link

coveralls commented May 26, 2016

Coverage Status

Coverage remained the same at 88.204% when pulling 3d271a0 on mvdoc:updatereadme into 8b05155 on duecredit:master.

@yarikoptic yarikoptic merged commit f4d87f0 into duecredit:master May 26, 2016
yarikoptic added a commit that referenced this pull request Jun 17, 2016
[Full Changelog](0.5.0...0.6.0)

**Implemented enhancements:**

- Support system-specific references [\#81](#81)
- export to bibtex doesn't support tags yet [\#19](#19)
- ENH: support DUECREDIT\_REPORT\_ALL=1 to report all citations, not only with functionality used [\#92](#92) ([yarikoptic](https://github.com/yarikoptic))

**Fixed bugs:**

- Outputting to bibtex doesn't filter by used citations [\#68](#68)
- references package even if no cited functions/methods used [\#48](#48)
- When injecting multiple citations at the same point, only one referenced [\#47](#47)

**Merged pull requests:**

- BF: allow multiple injections at the same path, avoid resetting \_orig\_import if already deactivated [\#91](#91) ([yarikoptic](https://github.com/yarikoptic))
- DOC: Update readme to reflect current output of duecredit summary [\#89](#89) ([mvdoc](https://github.com/mvdoc))
- enable codecov coverage reports [\#87](#87) ([yarikoptic](https://github.com/yarikoptic))
- REF,ENH: refactor {BibTeX,Text}Output into Output class with subclasses [\#86](#86) ([mvdoc](https://github.com/mvdoc))

* tag '0.6.0': (39 commits)
  CHANGELOG
  DOC: clarify DUECREDIT_REPORT_ALL usage
  ENH: use any instead of list when filtering packages
  DOC: Update readme to show how to use the new flag
  TST: test also DUECREDIT_REPORT_TAGS while we're at it
  TST: test all the flags
  TST: test that DUECREDIT_REPORT_ALL works
  ENH: support DUECREDIT_REPORT_ALL=1
  DOC: Update readme
  DOC: fix small change to readme
  DOC: update readme to reflect current output
  ENH: do not demand coverage for the code we hope should never be triggered
  BF: exec to figure out version should be done with locals(), globals()
  ???: naively hoping that previous bug triggered on travis would be gone fixed by prev fix
  ENH+RF: track per injector either it is active and do not deactivate in __del__ if not
  TST: add test for double injection
  BF+ENH(LOG): decorate prev decorated object during injection + improve logging
  enable codecov coverage reports
  Fix Py3 annoyances
  BF: BibTeXOutput returns only unique bibtexs
  ...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants