relay icon indicating copy to clipboard operation
relay copied to clipboard

Cargo doc fails to generate documentation

Open nathaniel-brough opened this issue 1 year ago • 5 comments

When familiarising myself with the relay compiler codebase I ran;

cd compiler
cargo doc --open

There are a slew of errors that come up with URLs int the documentation that aren't formatted correctly in docstrings.

nathaniel-brough avatar Jan 06 '24 23:01 nathaniel-brough

I've got a partial fix in #4568, but I haven't added this the CI yet to prevent future regressions.

nathaniel-brough avatar Jan 07 '24 00:01 nathaniel-brough

https://github.com/facebook/relay/pull/4568 has merged. Would you like to add a test to CI?

captbaritone avatar Jan 10 '24 18:01 captbaritone

#4568 has merged. Would you like to add a test to CI?

Done in #4580

nathaniel-brough avatar Jan 10 '24 20:01 nathaniel-brough

Scratch that WIP in #4580

nathaniel-brough avatar Jan 10 '24 20:01 nathaniel-brough

Now it's done

nathaniel-brough avatar Jan 10 '24 20:01 nathaniel-brough