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

Docstring Format fix #382

Merged
merged 4 commits into from
May 30, 2020
Merged

Docstring Format fix #382

merged 4 commits into from
May 30, 2020

Conversation

PhilipMay
Copy link
Contributor

The docstring formatting has some small bugs. See here:

  1. https://farm.deepset.ai/api/running.html#farm.train.EarlyStopping.__init__
  2. https://farm.deepset.ai/api/running.html#farm.train.EarlyStopping.check_stopping
  3. https://farm.deepset.ai/api/modeling.html#farm.modeling.adaptive_model.AdaptiveModel.forward_lm

The reason is that we need a blank line before the parameter section and the text section. This is fixed here.

@PhilipMay
Copy link
Contributor Author

PhilipMay commented May 30, 2020 •
edited
Loading

Also fixed 2 errors like this:

Warning, treated as error:
/home/mike/dev/git/FARM/farm/train.py:docstring of farm.train.EarlyStopping.check_stopping:6:Field list ends without a blank line; unexpected unindent.

This fix also seems to fix the CI problem. See this commit: 4109389

@PhilipMay PhilipMay mentioned this pull request May 30, 2020
Merged
1 task
tholor
tholor approved these changes May 30, 2020
View reviewed changes
Copy link
Member

@tholor tholor left a comment

Choose a reason for hiding this comment

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

Great! Thanks for fixing. We have this test in the CI to find broken docstrings but it doesn't capture all cases.

@tholor tholor merged commit 258a76f into deepset-ai:master May 30, 2020
@PhilipMay PhilipMay mentioned this pull request May 30, 2020
Closed
@PhilipMay PhilipMay deleted the doc-format-fix branch June 1, 2020 18:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@tholor tholor tholor approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@PhilipMay @tholor