apollographql / apollographql/federation

Add documentation to public structs/functions/macros

Open
#207 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
TypeScript
Stars
725
Forks
276
Avg merge
1h 47m
Merged PRs (30d)
1

Description

We can achieve this by adding
```rust
#![deny(missing_docs)]
```
To the top of crates' `lib.rs`/`main.rs` file, building and fixing all of the places where it complains.

Contributor guide

Open the contributing guide

Research direction

Locate each crate's lib.rs or main.rs and add the proposed missing-docs lint before building. Follow the resulting diagnostics across the crates and add documentation wherever reported; done means the build completes without missing-documentation errors.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.