Skip to content

docs: clarify that khard does not speak CardDAV#304

Merged
lucc merged 1 commit intolucc:developfrom
bitfehler:bitfehler/doc-updates
Mar 7, 2022
Merged

docs: clarify that khard does not speak CardDAV#304
lucc merged 1 commit intolucc:developfrom
bitfehler:bitfehler/doc-updates

Conversation

@bitfehler
Copy link
Contributor

Just to avoid some frustration for folks that found khard when looking
for a CardDAV client.

Note: CardDAV is also used throughout the code, but I don't think that
that's how people find khard. The important parts are the README and the
docs, and the description in setup.py.

Fixes: #303

setup.py Outdated
long_description_content_type='text/markdown',
license='GPL',
keywords='Carddav console addressbook',
keywords='Vcard console addressbook',

Choose a reason for hiding this comment

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

Why is this in upper case? I see it was the same before but when we are already touching this, why not keep all keywords lower case?

Copy link
Owner

Choose a reason for hiding this comment

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

wikipedia cases it as "vCard": https://en.wikipedia.org/wiki/VCard

Copy link
Owner

Choose a reason for hiding this comment

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

Thinking about it again, I agree with @mschilli87 , the keywords could all be lower case.

@bitfehler you can decide yourself if you want to style the other places in the prose as "vCard" or "vcard".

Copy link
Owner

@lucc lucc left a comment

Choose a reason for hiding this comment

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

LGTM apart from my comment.

setup.py Outdated
long_description_content_type='text/markdown',
license='GPL',
keywords='Carddav console addressbook',
keywords='Vcard console addressbook',
Copy link
Owner

Choose a reason for hiding this comment

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

Thinking about it again, I agree with @mschilli87 , the keywords could all be lower case.

@bitfehler you can decide yourself if you want to style the other places in the prose as "vCard" or "vcard".

@lucc
Copy link
Owner

lucc commented Mar 3, 2022

@scheibler can you update the short description of the github repo please. I do not have enough access rights to do that.

Just to avoid some frustration for folks that found khard when looking
for a CardDAV client.

Note: CardDAV is also used throughout the code, but I don't think that
that's how people find khard. The important parts are the README and the
docs, and the description in `setup.py`.

Fixes: lucc#303
@bitfehler bitfehler force-pushed the bitfehler/doc-updates branch from 67564e9 to 7648199 Compare March 7, 2022 13:04
@bitfehler
Copy link
Contributor Author

Thanks, y'all! Made the keyword all lowercase and went with vCard in the other case, including two new changes where VCARD was used in the next sentence, just for consistency.

@lucc lucc merged commit 8f73b83 into lucc:develop Mar 7, 2022
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.

Potentially misleading project/package description?

3 participants