renaming

Author: psnairne

src/caching/redb_cacher.rs

@@ -79,17 +79,16 @@ impl<T: Cacheable> Default for RedbCacher<T> {
     fn default() -> Self {
         let pkg_name = env!("CARGO_PKG_NAME");
 
-        let pivot_cache_dir = ProjectDirs::from("", "", pkg_name)
+        let pivotal = ProjectDirs::from("", "", pkg_name)
             .map(|project_dir| project_dir.cache_dir().to_path_buf())
             .or_else(|| home_dir().map(|home| home.join(pkg_name)))
             .unwrap_or_else(|| panic!("Could not find cache directory or home directory."));
 
-        if !pivot_cache_dir.exists() {
-            fs::create_dir_all(&pivot_cache_dir)
-                .expect("Failed to create default cache directory.");
+        if !pivotal.exists() {
+            fs::create_dir_all(&pivotal).expect("Failed to create default cache directory.");
         }
 
-        RedbCacher::new(pivot_cache_dir.join(type_name::<T>()))
+        RedbCacher::new(pivotal.join(type_name::<T>()))
     }
 }
 

src/hgnc/mod.rs

@@ -43,7 +43,7 @@
 //! ## HGNCClient
 //!
 //! ```rust
-//! use pivot::hgnc::{HGNCClient, HGNCData, GeneQuery};
+//! use pivotal::hgnc::{HGNCClient, HGNCData, GeneQuery};
 //!
 //! let client = HGNCClient::default();
 //! let gene_symbol = client.request_gene_symbol(GeneQuery::from("HGNC:13089")).unwrap();
@@ -54,7 +54,7 @@
 //! ## CachedHGNCClient
 //!
 //! ```rust
-//! use pivot::hgnc::{HGNCClient, HGNCData, GeneQuery, CachedHGNCClient};
+//! use pivotal::hgnc::{HGNCClient, HGNCData, GeneQuery, CachedHGNCClient};
 //!
 //! let temp_dir = tempfile::tempdir().expect("Failed to create temporary directory");
 //! let cache_file_path = temp_dir.path().join("cache.hgnc");

src/hgvs/mod.rs

@@ -37,7 +37,7 @@
 //! ## HGVSClient
 //!
 //! ```rust
-//! use pivot::hgvs::{HGVSClient, HGVSData};
+//! use pivotal::hgvs::{HGVSClient, HGVSData};
 //!
 //! let client = HGVSClient::default();
 //! let hgvs_variant = client.request_and_validate_hgvs("NM_001173464.1:c.2860C>T").unwrap();
@@ -48,7 +48,7 @@
 //! ## CachedHGVSClient
 //!
 //! ```rust
-//! use pivot::hgvs::{CachedHGVSClient, HGVSClient, HGVSData};
+//! use pivotal::hgvs::{CachedHGVSClient, HGVSClient, HGVSData};
 //!
 //! let temp_dir = tempfile::tempdir().expect("Failed to create temporary directory");
 //! let cache_file_path = temp_dir.path().join("cache.hgvs");
@@ -65,11 +65,11 @@
 //! ## Creating VariantInterpretations from HgvsVariant objects
 //!
 //! ```rust
-//! use pivot::hgvs::{AlleleCount, ChromosomalSex, HGVSClient, HGVSData};
+//! use pivotal::hgvs::{AlleleCount, ChromosomalSex, HGVSClient, HGVSData};
 //!
 //! let client = HGVSClient::default();
 //! let hgvs_variant = client.request_and_validate_hgvs("NM_001173464.1:c.2860C>T").unwrap();
-//! let vi = hgvs_variant.create_variant_interpretation(AlleleCount::Single, ChromosomalSex::XX);
+//! let vi = hgvs_variant.create_variant_interpretation(AlleleCount::Single, &ChromosomalSex::XX);
 //!
 //! let vi_allelic_state = vi.unwrap().variation_descriptor.unwrap().allelic_state.unwrap().label;
 //! assert_eq!("heterozygous", vi_allelic_state);