rapidsai / rapids-cmake

https://docs.rapids.ai/api/rapids-cmake/stable/
Apache License 2.0
27 stars 45 forks source link

fix docs for rapids_export_ functions #589

Closed jameslamb closed 4 months ago

jameslamb commented 4 months ago

Description

Reading through https://docs.rapids.ai/api/rapids-cmake/stable/api/ today, I noticed two apparent typos

This fixes those, along with another formatting error causing one of them to not be rendered as inline code.

Screenshot 2024-04-22 at 12 31 27 PM

Notes for Reviewers

I'd expect to see typos like this caught by sphinx... but I don't see any warnings raised in the most recent docs build for this repo (build link). So I'm not sure how to easily prevent such things in CI in the future.

Maybe something like a CI job that does link-checking across RAPIDS would be able to catch things like this in the future. Linking the relevant issue tracking that idea: https://github.com/rapidsai/build-planning/issues/9

Checklist

robertmaynard commented 4 months ago

/merge