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

Fix typos on docstrings #288

Closed
wants to merge 1 commit into from
Closed

Fix typos on docstrings #288

wants to merge 1 commit into from

Conversation

jcrawford
Copy link

@jcrawford jcrawford commented Sep 28, 2020 •
edited by santisoler
Loading

Fix typos on functions docstrings from distances.py and
model_selection.py.

Fixes #287

@welcome
Copy link

welcome bot commented Sep 28, 2020

💖 Thanks for opening your first pull request! 💖

Please make sure you read the following:

  • Authorship Guidelines: Our rules for giving you credit for your contributions, including authorship on publications and Zenodo archives.
  • Contributing Guide: What the review process is like and our infrastructure for testing and documentation.
  • Code of Conduct: How we expect people to interact in our projects.

A few things to keep in mind:

  • Remember to run make format to make sure your code follows our style guide.
  • If you need help writing tests, take a look at the existing ones for inspiration. If you don't know where to start, let us know and we'll walk you through it.
  • All new features should be documented. It helps to write the docstrings for your functions/classes before writing the code. This will help you think about your code design and results in better code.
  • No matter what, we are really grateful that you put in the effort to do this! ⭐

@jcrawford jcrawford changed the title Issue 287 - FIxy typos in a few files Issue 287 - Fixing a few typos in a few files Sep 28, 2020
@santisoler santisoler mentioned this pull request Sep 29, 2020
Closed
santisoler
santisoler requested changes Sep 29, 2020
View reviewed changes
Copy link
Member

@santisoler santisoler left a comment

Choose a reason for hiding this comment

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

Hi @jcrawford, thanks for opening the PR.
I leave a single suggestion on one of the changes.
After it's addressed we can merge this.

verde/distances.py
@@ -15,7 +15,7 @@ def median_distance(coordinates, k_nearest=1, projection=None):
distance to its *k_nearest* neighbors among the other points in the
dataset. Sparse uniformly spaced datasets can use *k_nearest* of 1.
Datasets with points clustered into tight groups (e.g., densely sampled
along a flight line or ship treck) will have very small distances to the
along a flight line or ship wreck) will have very small distances to the
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
along a flight line or ship wreck) will have very small distances to the
along a flight line or ship track) will have very small distances to the

@santisoler santisoler changed the title Issue 287 - Fixing a few typos in a few files Fix typos on docstrings Sep 29, 2020
@santisoler santisoler mentioned this pull request Sep 29, 2020
Closed
@santisoler
Copy link
Member

The author hasn't addressed the requested changes after 14 days, so we decided to close this PR for now.

@santisoler santisoler closed this Oct 13, 2020
@dcslagel dcslagel mentioned this pull request Nov 28, 2020
Merged
6 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@santisoler santisoler santisoler requested changes

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

Successfully merging this pull request may close these issues.

Fix typos on docstrings
2 participants
@jcrawford @santisoler