Skip to content

Docs: clearer description for booleanOverlap#2133

Merged
mfedderly merged 1 commit intoTurfjs:masterfrom
chloebrett:docs/clearer-description-for-boolean-overlap
Jun 28, 2021
Merged

Docs: clearer description for booleanOverlap#2133
mfedderly merged 1 commit intoTurfjs:masterfrom
chloebrett:docs/clearer-description-for-boolean-overlap

Conversation

@chloebrett
Copy link
Copy Markdown

@chloebrett chloebrett commented Jun 27, 2021

Adds a line explaining booleanOverlap in a more layman-friendly way.

This is my first PR for this project so please feel free to suggest improvements to the PR structure etc.

Do I need to run npm run docs so that they update? I tried doing this but it rewrote all the READMEs and made them empty, so I've only committed the changed source file instead.

resolves #2072

  • Use a meaningful title for the pull request. Include the name of the package modified.
  • Have read How To Contribute.
  • Run npm test at the sub modules where changes have occurred.
  • Run npm run lint to ensure code style at the turf module level.

@mfedderly
Copy link
Copy Markdown
Collaborator

The docs are updated by @rowanwins occasionally. I think its on his list to update sometime soon.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

booleanOverlap description is obtuse

2 participants