Skip to content

Commit

Permalink
minor docs changes
Browse files Browse the repository at this point in the history
  • Loading branch information
Quba1 committed Feb 6, 2024
1 parent 9974f5d commit 365c5eb
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 34 deletions.
5 changes: 2 additions & 3 deletions src/codes_index.rs
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@ use std::path::Path;
pub struct CodesIndex {
pub(crate) pointer: *mut codes_index,
}

#[cfg_attr(docsrs, doc(cfg(feature = "experimental_index")))]
pub trait Select<T> {
fn select(self, key: &str, value: T) -> Result<CodesIndex, CodesError>;
}
Expand All @@ -28,9 +30,6 @@ impl CodesIndex {

let index_handle;
unsafe {
// technically codes_index_new can also select keys
// but that would unnecessarily diverge the API
// and would be error prone
index_handle = codes_index_new(&keys)?;
}
Ok(CodesIndex {
Expand Down
31 changes: 0 additions & 31 deletions src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -157,37 +157,6 @@
//! # }
//!```
//!
//!### ecCodes installation
//!
//!This crate uses [eccodes-sys](https://crates.io/crates/eccodes-sys) with default options to link ecCodes.
//!Check `eccodes-sys` website for more details on how it links the library.
//!
//!The recommended way to install ecCodes on your computer is using your package manager.
//!For example, on Ubuntu you can use `apt-get`:
//!
//!```text
//!sudo apt-get install libeccodes-dev
//!```
//!
//!or `brew` on MacOS:
//!
//!```text
//!brew install eccodes
//!```
//!
//!Alternatively, you can install the library manually from source in suitable directory
//!following [this instructions](https://confluence.ecmwf.int/display/ECC/ecCodes+installation).
//!
//!Then add the `lib/pkgconfig` directory from your ecCodes installation directory
//!to the `PKG_CONFIG_PATH` environmental variable. If ecCodes have been compiled
//!as shared library you will also need to specify `LD_LIBRARY_PATH`.
//!For example:
//!
//!```text
//!$ export PKG_CONFIG_PATH=<your_eccodes_path>/lib/pkgconfig
//!$ export LD_LIBRARY_PATH=<your_eccodes_path>/lib
//!```
//!
//!### Features
//!
//!- `docs` - builds the crate without linking ecCodes, particularly useful when building the documentation
Expand Down

0 comments on commit 365c5eb

Please sign in to comment.