From c4a723b296a95054cc4e950f6e45551a32e570bd Mon Sep 17 00:00:00 2001
From: Martin Larralde <martin.larralde@embl.de>
Date: Thu, 17 Feb 2022 03:24:28 +0100
Subject: [PATCH] Rename `AminoAcid` methods for consistency

---
 README.md  |  7 ++++---
 src/lib.rs | 16 ++++++++--------
 2 files changed, 12 insertions(+), 11 deletions(-)

diff --git a/README.md b/README.md
index 1b34a1e..a6b904c 100644
--- a/README.md
+++ b/README.md
@@ -27,7 +27,7 @@ extern crate proteinogenic;
 
 let residues = "KGILGKLGVVQAGVDFVSGVWAGIKQSAKDHPNA"
   .chars()
-  .map(proteinogenic::AminoAcid::from_code1)
+  .map(proteinogenic::AminoAcid::from_char)
   .map(Result::unwrap);
 let s = proteinogenic::smiles(residues)
   .expect("failed to generate SMILES string");
@@ -45,7 +45,7 @@ extern crate proteinogenic;
 
 let residues = "GLPVCGETCVGGTCNTPGCTCSWPVCTRN"
   .chars()
-  .map(proteinogenic::AminoAcid::from_code1)
+  .map(proteinogenic::AminoAcid::from_char)
   .map(Result::unwrap);
 
 let mut p = proteinogenic::Protein::new(residues);
@@ -75,7 +75,8 @@ extern crate purr;
 
 let sequence = "KGILGKLGVVQAGVDFVSGVWAGIKQSAKDHPNA";
 let residues = sequence.chars()
-  .map(|c| proteinogenic::AminoAcid::from_code1(c).unwrap());
+  .map(proteinogenic::AminoAcid::from_char)
+  .map(Result::unwrap);
 
 let mut builder = purr::graph::Builder::new();
 proteinogenic::visit(residues, &mut builder);
diff --git a/src/lib.rs b/src/lib.rs
index a265862..9d9466b 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -221,7 +221,7 @@ pub enum AminoAcid {
 
 impl AminoAcid {
     /// Create an `AminoAcid` variant from a 1-letter code.
-    pub fn from_code1(code: char) -> Result<AminoAcid, UnknownResidue> {
+    pub fn from_char(code: char) -> Result<AminoAcid, UnknownResidue> {
         match code {
             'R' => Ok(AminoAcid::Arg),
             'H' => Ok(AminoAcid::His),
@@ -250,7 +250,7 @@ impl AminoAcid {
     }
 
     /// Create an `AminoAcid` variant from a 3-letter code.
-    pub fn from_code3(code: &str) -> Result<AminoAcid, UnknownResidue> {
+    pub fn from_code(code: &str) -> Result<AminoAcid, UnknownResidue> {
         match code {
             "Arg" => Ok(AminoAcid::Arg),
             "His" => Ok(AminoAcid::His),
@@ -866,14 +866,14 @@ mod tests {
     }
 
     #[test]
-    fn from_code1() {
-        assert_eq!(AminoAcid::from_code1('Y'), Ok(AminoAcid::Tyr));
-        assert_eq!(AminoAcid::from_code1('α'), Err(UnknownResidue));
+    fn from_char() {
+        assert_eq!(AminoAcid::from_char('Y'), Ok(AminoAcid::Tyr));
+        assert_eq!(AminoAcid::from_char('α'), Err(UnknownResidue));
     }
 
     #[test]
-    fn from_code3() {
-        assert_eq!(AminoAcid::from_code3("Thr"), Ok(AminoAcid::Thr));
-        assert_eq!(AminoAcid::from_code3("Xyz"), Err(UnknownResidue));
+    fn from_code() {
+        assert_eq!(AminoAcid::from_code("Thr"), Ok(AminoAcid::Thr));
+        assert_eq!(AminoAcid::from_code("Xyz"), Err(UnknownResidue));
     }
 }