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

Document everything in the heed, heed-types and heed-traits crates #153

Closed
Kerollmops opened this issue Jan 12, 2023 · 0 comments · Fixed by #177
Closed

Document everything in the heed, heed-types and heed-traits crates #153

Kerollmops opened this issue Jan 12, 2023 · 0 comments · Fixed by #177
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Milestone
v0.20.0

Comments

@Kerollmops
Copy link
Member

Kerollmops commented Jan 12, 2023 •
edited

We must document everything and warn about missing doc parts. We should also update the CI to break when a warning is thrown.

// lib.rs
#![warn(missing_docs)]
@Kerollmops Kerollmops added documentation Improvements or additions to documentation good first issue Good for newcomers labels Jan 12, 2023
@Kerollmops Kerollmops added this to the v0.20.0 milestone Jan 12, 2023
AureliaDolo added a commit to AureliaDolo/heed that referenced this issue Jul 5, 2023
@AureliaDolo
Add missing documentation.
26f0ff3 
Fix meilisearch#153
AureliaDolo added a commit to AureliaDolo/heed that referenced this issue Jul 5, 2023
@AureliaDolo
Add missing documentation.
d1c7444 
Fix meilisearch#153
@AureliaDolo AureliaDolo mentioned this issue Jul 5, 2023
Merged
AureliaDolo added a commit to AureliaDolo/heed that referenced this issue Jul 5, 2023
@AureliaDolo
Add missing documentation.
28e6abf 
Fix meilisearch#153
AureliaDolo added a commit to AureliaDolo/heed that referenced this issue Jul 7, 2023
@AureliaDolo
Add missing documentation.
6e9b0ec 
Fix meilisearch#153
darnuria pushed a commit to darnuria/heed that referenced this issue Jul 11, 2023
@AureliaDolo @darnuria
Add missing documentation.
229abe0 
Fix meilisearch#153
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Milestone
v0.20.0
Development

Successfully merging a pull request may close this issue.

Add missing documentation. AureliaDolo/heed
1 participant
@Kerollmops