Skip to content

Update package.json for all turf packages#2802

Merged
smallsaucepan merged 6 commits into
Turfjs:masterfrom
protokoul:docs/update-package-json-for-turf-packages
Jan 8, 2025
Merged

Update package.json for all turf packages#2802
smallsaucepan merged 6 commits into
Turfjs:masterfrom
protokoul:docs/update-package-json-for-turf-packages

Conversation

@protokoul

@protokoul protokoul commented Dec 31, 2024

Copy link
Copy Markdown
Contributor

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

@smallsaucepan smallsaucepan left a comment

Copy link
Copy Markdown
Contributor

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!

Comment thread packages/turf-tin/package.json Outdated
Comment thread packages/turf-sector/package.json Outdated
Comment thread packages/turf-rhumb-distance/package.json Outdated
Comment thread packages/turf-rewind/package.json Outdated
Comment thread packages/turf-polygon-to-line/package.json Outdated
Comment thread packages/turf-line-chunk/package.json Outdated
Comment thread packages/turf-circle/package.json Outdated
@smallsaucepan
smallsaucepan merged commit 991d3ac into Turfjs:master Jan 8, 2025
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