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

Suggestion to clarify the manual #132

Closed
bertulli opened this issue Sep 4, 2022 · 4 comments
Closed

Suggestion to clarify the manual #132

bertulli opened this issue Sep 4, 2022 · 4 comments

Comments

@bertulli
Copy link

bertulli commented Sep 4, 2022

Hi all!
I was using this package and I noticed the manual is quite unclear, almost misleading about the usage of \cventry. It is said (section 3.2): "in the sections describing your education or your job experiences, you can use:

\cventry{years}{degree/job title}{institution/employer}
{localization}{optional: grade/...}
{optional: comment/job description}

where the last three arguments are optional"

The point is that the arguments are not actually optional, they are mandatory, but they can be left empty. If I try to use them as optional (not providing them), I get errors, as you can see in this TeX SE question.

Maybe the documentation can be reworded? I can do a PR if you like it.

@stephanlachnit
Copy link
Member

Maybe the documentation can be reworded? I can do a PR if you like it.

Yes, the documentation needs to be reworked. There was some previous work at #58. Feel free to give it a try!

@bertulli
Copy link
Author

bertulli commented Sep 6, 2022 via email

@ShadowMitia
Copy link

I haven't built the userguide yet, but I think you are missing some examples that are compiled?
You probably need this PR #54 to get the Makefile which should help you generate everything (hopefully).

@stephanlachnit
Copy link
Member

However, I made the "basic" PR, meaning that I only changed the unclear
part of the manual (line 286). Is it ok?

Yes, thanks! Closed via #133

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

No branches or pull requests

3 participants