docs: Review docstrings #199
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
xmnlab
reviewed
Nov 28, 2022
epigraphhub/data/colombia/extract.py
Outdated
| @@ -1,7 +1,6 @@ | |||
| """ | |||
| Last change on 2022/09/22 | |||
| Comparing Colombia Governmental COVID data consists in a step before pushing it to | |||
| the SQL Database. Is responsible for retrieving the last date in both CSV and SQL table. | |||
| Comparing Colombia Governmental COVID data consists in a step before pushing it to the SQL Database. Is responsible for retrieving the last date in both CSV and SQL table. | |||
There was a problem hiding this comment.
any reason to keep the line so long?
There was a problem hiding this comment.
No, locally it does not appear like that.
xmnlab
reviewed
Nov 28, 2022
epigraphhub/data/colombia/extract.py
Outdated
| @@ -59,14 +61,17 @@ def _table_last_update() -> datetime: | |||
|
|
|||
| def _web_last_update() -> datetime: | |||
| """ | |||
| This method will request the maximum date found in Colombia data through Socrata API | |||
| and returns it as a datetime object for further evaluation. | |||
| This method will request the maximum date found in Colombia data through Socrata API and returns it as a datetime object for further evaluation. | |||
There was a problem hiding this comment.
please keep the line with less than 80 characters (<=79)
xmnlab
reviewed
Nov 29, 2022
There was a problem hiding this comment.
I've not read all the changes .. but in general .. it looks good to me.
thanks for working on that.
@eduardocorrearaujo could you review this one?
epigraphhub/data/worldbank.py
Outdated
| @@ -127,19 +135,25 @@ def search_in_database(keyword): | |||
|
|
|||
|
|
|||
| def search_in_indicators(keyword, db=2): | |||
|
|
|||
There was a problem hiding this comment.
I think we don't need this empty line here
epigraphhub/data/worldbank.py
Outdated
| @@ -151,29 +165,36 @@ def search_in_indicators(keyword, db=2): | |||
|
|
|||
|
|
|||
| def get_worldbank_data(ind, country, db=2, time="all", columns=None): | |||
|
|
|||
|
Stale pull request message |
fccoelho
approved these changes
Jan 31, 2023
|
It is looking good. We can merge it |
eduardocorrearaujo
approved these changes
Jan 31, 2023
|
🎉 This PR is included in version 2.0.2 🎉 The release is available on:
Your semantic-release bot 📦🚀 |
fccoelho
pushed a commit
that referenced
this pull request
Feb 14, 2023
* Review docstrings * Review doscstring * Arrangement of number of characters in the lines * Update worldbank.py
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Review docstrings:
forecast_swiss.py
metrics.py
ngboost_models.py
preprocessing.py
epigraphhub_db.py
worldbank.py
Fixed docstring formatting as it was in most cases.
Checklist
CODE_OF_CONDUCT.mddocument.CONTRIBUTING.mdguide.chore(docs):for Examples / docs / tutorials / dependencies updatefix:for a bug fix(non-breaking change which fixes an issue).
chore(improvement):for an improvement(non-breaking change which improves an existing feature).
feat:for a new feature(non-breaking change which adds functionality).
BREAKING CHANGE:for a breaking change(fix or feature that would cause existing functionality to change).
chore(security):for a security fix.Note: The title prefix can be also expanded with more information
inside the parenthesis. Some examples for a full title (prefix + message):
fix(login): Fix the login page.feat(forecast): Add a weather forecast page.chore(security-login): Add a weather forecast page.