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.

Sign up for GitHub

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

Jump to bottom

README Example [intermediate to advanced but interesting] #13

Open
Tamschi opened this issue Oct 1, 2021 · 0 comments
Open

README Example [intermediate to advanced but interesting] #13

Tamschi opened this issue Oct 1, 2021 · 0 comments
Labels
good first issue Good for newcomers Hacktoberfest A good-for-Hacktoberfest issue. This label is only maintained in October. type: documentation Related to documentation and information. work: novel There's a problem, and both goal and solution are unclear.

Comments

@Tamschi
Copy link
Owner

Tamschi commented Oct 1, 2021

Is your feature request related to a problem? Please describe.

There currently is no proper usage example for this library.

Describe the solution you'd like

The ## Example code block in README should show how to use this schema implementation's validation features and briefly explain how to surface hover documentation through rust-analyzer.

Describe alternatives you've considered

None.

Additional context

Asteracea uses this this schema crate fairly extensively, but it's pretty buried behind the procedural macro. If you're interested, I'd guide you through that project to teach you the relevant macro skills for this task.
@Tamschi Tamschi added type: documentation Related to documentation and information. good first issue Good for newcomers work: novel There's a problem, and both goal and solution are unclear. Hacktoberfest A good-for-Hacktoberfest issue. This label is only maintained in October. labels Oct 1, 2021
@Tamschi Tamschi changed the title README Example [Hacktoberfest: intermediate to advanced but interesting] README Example [intermediate to advanced but interesting] Oct 1, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
good first issue Good for newcomers Hacktoberfest A good-for-Hacktoberfest issue. This label is only maintained in October. type: documentation Related to documentation and information. work: novel There's a problem, and both goal and solution are unclear.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@Tamschi