Skip to content
This repository has been archived by the owner on Dec 22, 2021. It is now read-only.

Adding duecredit decorators to all relevant functions #423

Closed
wants to merge 2 commits into from
Closed

Adding duecredit decorators to all relevant functions #423

wants to merge 2 commits into from

Conversation

mtb-za
Copy link
Contributor

@mtb-za mtb-za commented Jan 31, 2018 •
edited

Fixes #292

Starting to go through everything to give it a citation.

Checklist:

  • Make tests for new code (at least 80% coverage)
  • Create/update docstrings
  • Include relevant equations and citations in docstrings
  • Docstrings follow the style conventions
  • Code follows PEP8 style conventions
  • Code and docs have been spellchecked
  • Include new dependencies in doc/install.rst, environment.yml, ci/requirements.txt.
  • Documentation builds properly (run cd doc; make locally)
  • Changelog entry (leave for last to avoid conflicts)

@mtb-za
Copy link
Contributor Author

mtb-za commented Feb 1, 2018 •
edited

Is there a reason that the citations in some places are only in the main docstring, not in the ones for individual methods? Should I add them to function docstrings as I go through them all?

So far:

  • gravmag.imaging
  • gravmag.normal_gravity

@mtb-za mtb-za changed the title Added duecredit options to gravmag.transform Adding duecredit decorators to all relevant functions Feb 1, 2018
@mtb-za mtb-za mentioned this pull request Feb 1, 2018
Open
@mtb-za
Copy link
Contributor Author

mtb-za commented Feb 1, 2018

Modules with credit

I will add these as I go, so this will be edited.

@mtb-za
Added duecredit for remaining fatiando.gravmag modules
5327332 
Note that some are currently broken due to a bug in citeproc-py, in
particular where page numbers are non-integers.

This is now complete for the `gravmag` module, although I noticed some
modules do not have references in the docstrings of individual methods.
If desired, they will be fixed as part of this PR.
@mtb-za mtb-za self-assigned this Feb 1, 2018
@leouieda
Copy link
Member

leouieda commented Feb 8, 2018

@mtb-za thanks for going through the trouble of adding these!

Is there a reason that the citations in some places are only in the main docstring, not in the ones for individual methods?

Yes. Inconsistent practices on my part and old code that hasn't been updated in years :)
I really need to aggressively remove old and broken stuff from Fatiando.

@leouieda
Copy link
Member

leouieda commented Feb 8, 2018 •
edited

Should I add them to function docstrings as I go through them all?

That would be great!

@leouieda leouieda closed this Feb 27, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers
No reviews
Assignees

@mtb-za mtb-za

Labels
enhancement
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Provide citation information for all functions/classes/modules
2 participants
@mtb-za @leouieda