Make an internal API warning macro

lancedb / lance

Modern columnar data format for ML and LLMs implemented in Rust. Convert from parquet in 2 lines of code for 100x faster random access, vector index, and data versioning. Compatible with Pandas, DuckDB, Polars, Pyarrow, with more integrations coming..

https://lancedb.github.io/lance/

Apache License 2.0

3.33k stars 171 forks source link

Make an internal API warning macro #2287

Open chebbyChefNEQ opened 2 weeks ago

chebbyChefNEQ commented 2 weeks ago

We often expose internal APIs. These APIs are pub but really shouldn't be used as we will not garueentee the stability.

Maybe we could use depercated mechanism to generate a warning when someone touches these APIs.

Maybe there is a better way, this ticket is to track and solve this problem.

chebbyChefNEQ commented 2 weeks ago

potentially interesting solution: https://github.com/rust-lang/api-guidelines/discussions/95 (via feature flag)