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.

Sign up for GitHub

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

Jump to bottom

Move docstring #815

Merged
merged 2 commits into from
Jan 28, 2019
Merged

Move docstring #815

merged 2 commits into from
Jan 28, 2019

Conversation

Morendil
Copy link
Contributor

@Morendil Morendil commented Jan 24, 2019 •
edited by sandcha
Loading

Technical changes

  • Quell a warning in the build of openfisca-doc by moving a docstring to the right place

@Morendil Morendil self-assigned this Jan 24, 2019
sandcha
sandcha approved these changes Jan 28, 2019
View reviewed changes
Copy link
Collaborator

@sandcha sandcha left a comment

Choose a reason for hiding this comment

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

👍

Fixes this warning:

openfisca-core/openfisca_core/tracers.py:docstring of openfisca_core.tracers.Tracer.print_trace:None: WARNING: 'any' reference target not found: print_computation_log

Lessons learnt:

  • To be careful with openfisca-doc requirements as they use Core in editable mode but on master branch.
  • An internal link in sphinx docstring could be defined with :any:`method_name`

@sandcha sandcha merged commit 5025db5 into master Jan 28, 2019
@sandcha sandcha deleted the move-docstring branch January 28, 2019 15:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sandcha sandcha sandcha approved these changes

Assignees

@Morendil Morendil

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@Morendil @sandcha