Standardize doc-strings #26
Conversation
for more information, see https://pre-commit.ci
This reverts commit 2eb4db3.
This reverts commit 9f660ff.
for more information, see https://pre-commit.ci
for more information, see https://pre-commit.ci
| ignore-regex = '^\s*"image\/png":\s.*' | ||
| ignore-words-list = "gost," | ||
| ignore-words-list = "gost,GOST,ALOS,ans,NAM" |
There was a problem hiding this comment.
This ignore-words-list parameter doesn't seem to be working as expected so I had to add the relevant notebooks to the skip field above.
| [tool.ruff] | ||
| exclude = [ | ||
| "WSF_DECAT_B_ExploringIDCerrors.ipynb", | ||
| "KAZ_Urbanization_Review.ipynb", | ||
| "Urban_metrics_Fullness.ipynb", | ||
| "Urban_metrics_Shape.ipynb", | ||
| "Urban_metrics_Sprawl.ipynb", | ||
| "Urban_metrics_Structure.ipynb", | ||
| "URB_DECAT_B_ExploringGHSSMODcode.ipynb", | ||
| "URB_SCAUR_UKR_B_I_urbanizationReview.ipynb", | ||
| "URB_SEAU1_B_A_Ka_ExtractDataUrban.ipynb", | ||
| "Zonal_statistics.ipynb", | ||
| "Data_Preparation.ipynb", | ||
| "URB_SEAU1_B_A_Ka_NovelUrbanizaton.ipynb", | ||
| "Create_Mosaick_Datasets.ipynb", | ||
| "GHSL_Standardize_To_Country.ipynb", | ||
| "MAP_Urbanization.ipynb", | ||
| "NGA_specific_results.ipynb", | ||
| ] |
There was a problem hiding this comment.
Many of the notebooks in the Implementations/ folder contain paths to local file systems, or reference source code held relative to some local file system, so these don't work. There are also many examples of references to variables that are not used. I didn't want to delete these notebooks in the event they are of some importance.
Please weigh in and let me know what you think @bpstewar
There was a problem hiding this comment.
@g4brielvs looking for some guidance here as well beyond the overall review.
There was a problem hiding this comment.
@bpstewar @andresfchamorro Whenever you have a chance, could you please look into this?
|
Ready to be merged after #21 |
|
Resolved merge conflicts - still waiting for input on the "Implementations" notebooks that cannot be executed as they currently are (see comment / notes above). |
Close #15 by standardizing the doc-strings. To be merged after #21.
This PR standardizes the doc-strings per the numpy style. It also resolves the failing pre-commit continuous integration job, by fixing issues (primarily codespell and ruff) where possible, but also skipping files.