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.

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

Update package.json for all turf packages #2802

Open
wants to merge 6 commits into
base: master
Choose a base branch
from

Conversation

protokoul
Copy link

@protokoul protokoul commented Dec 31, 2024

This PR updates the description in package.json for all the turf packages. Almost all of the descriptions have been referenced from the API docs that can be found at https://turfjs.org. I could not find description for four packages in the API docs. These are turf-invariant, turf-projection, turf-meta, and turf-distance-weight.

  • Meaningful title, including the name of the package being modified.
  • Summary of the changes.
  • Heads up if this is a breaking change.
  • Any issues this resolves.
  • Inclusion of your details in the contributors field of package.json - you've earned it! 👏
  • Confirmation you've read the steps for preparing a pull request.

Resolves #2798

Copy link
Member

@smallsaucepan smallsaucepan left a comment

Choose a reason for hiding this comment

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

Thanks for doing this @protokoul. Noted a couple of descriptions that we could probably make shorter, or leave out some of the detail. If a potential user likes what they see, they can always click through to the README for specifics.

For example, we can just say polygon or geometry instead of listing (Multi)Polygon specifically. If you wouldn't mind, could you please scan through to see if there are any other opportunities to trim out some detail. Then we can go ahead and merge them in!

packages/turf-tin/package.json Outdated Show resolved Hide resolved
packages/turf-sector/package.json Outdated Show resolved Hide resolved
packages/turf-rhumb-distance/package.json Outdated Show resolved Hide resolved
packages/turf-rewind/package.json Outdated Show resolved Hide resolved
packages/turf-polygon-to-line/package.json Outdated Show resolved Hide resolved
packages/turf-line-chunk/package.json Outdated Show resolved Hide resolved
packages/turf-circle/package.json Outdated Show resolved Hide resolved
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.

Improve package descriptions in package.json files
2 participants