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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added ribir & unified punctiuation of descriptions #152

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

virtualritz
Copy link
Contributor

  • Added Ribir (repo).
    I didn't add tags since there are no written guiderails in the CONTRIBUTING.md for what that field should contain. The tags used in ecosystem.toml on other crates seem to follow no stringent logic. Some pertain to what, some to how, etc.

  • Unified use of punctuation in description fields. Some had a terminating period, some didn't.

P.S.: It would help if CONTRIBUTING.md listed all the fields one should populate, when a crate is not published on crates.io. Maybe an example toml snippet? 馃榿

@virtualritz virtualritz changed the title Added Ribir & unified punctiuation of descriptions Added ribir & unified punctiuation of descriptions Feb 25, 2024
Copy link
Collaborator

@madsmtm madsmtm left a comment

Choose a reason for hiding this comment

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

Re punctuation: Most crates on crates.io don't use a period, and this is where the description field is otherwise taken from. I'd rather not have a period in the data, and instead normalize the data from crates.io when outputting it (but that should be done in a separate PR).

Re tags: You're right that there isn't really any guidelines for these, I wanted to do #119, but that has kinda stalled.

@virtualritz
Copy link
Contributor Author

Re punctuation: Most crates on crates.io don't use a period, and this is where the description field is otherwise taken from. I'd rather not have a period in the data, and instead normalize the data from crates.io when outputting it (but that should be done in a separate PR).

Fair enough. But 'most' means some still do. What's more, ecosystem.toml has multi sentence descriptions.
What then? Don't have a period after the last sentence nevertheless?
As an ex typographer/designer, that makes my toenails curl.

The fact that there are no guiderails for the description field of a Cargo.toml doesn't mean areweguiyet can't do better.

If you decide to have a final period in those multi-sentence cases but not for the one sentence descriptions, the style is not stringent. I.e. why I made these changes.

Just saying. 馃榿

@madsmtm
Copy link
Collaborator

madsmtm commented Apr 18, 2024

I went and normalized the descriptions visually in #157, please update this PR to not change the description fields of the other crates

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.

None yet

2 participants