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

Minor doc fixups #640

Merged
merged 2 commits into from
May 22, 2024
Merged

Minor doc fixups #640

merged 2 commits into from
May 22, 2024

Conversation

gadomski
Copy link
Contributor

  • Clean up some docs warnings
  • Add #![cfg_attr(docsrs, feature(doc_auto_cfg))] to lib.rs to turn on feature flags in docs.rs, e.g. this from stac-rs:

kylebarron
kylebarron approved these changes May 22, 2024
View reviewed changes
Copy link
Member

@kylebarron kylebarron left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Awesome, thank you! I admit the docs are generally in a poor state. If there's anything that's confusing, let me know and I can write docstrings for that part first.

src/lib.rs
@@ -1,6 +1,8 @@
//! A Rust implementation of the [GeoArrow](https://github.com/geoarrow/geoarrow) specification,
//! plus algorithms implemented on and returning these GeoArrow arrays.

#![cfg_attr(docsrs, feature(doc_auto_cfg))]
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

TIL!

@kylebarron kylebarron merged commit 6c0f80b into geoarrow:main May 22, 2024
6 checks passed
@gadomski gadomski deleted the docs branch May 22, 2024 12:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@kylebarron kylebarron kylebarron approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@gadomski @kylebarron