-
Notifications
You must be signed in to change notification settings - Fork 9
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
docs: Review docstrings #199
Conversation
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
any reason to keep the line so long?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
No, locally it does not appear like that.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
please keep the line with less than 80 characters (<=79)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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): | |||
|
|||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
same here
Stale pull request message |
It is looking good. We can merge it |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It looks good. Thank you @YurelyCamacho
🎉 This PR is included in version 2.0.2 🎉 The release is available on:
Your semantic-release bot 📦🚀 |
* Review docstrings * Review doscstring * Arrangement of number of characters in the lines * Update worldbank.py
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.md
document.CONTRIBUTING.md
guide.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
.