OBJNULL/Express-Prorate
1
0
Fork 0
generated from OBJNULL/Dockerized-Rust
Code Issues Pull requests Projects Releases 1 Packages Wiki Activity Actions

Added documentation to start

Browse source
This commit is contained in:
Maddox Werts 2025-08-02 15:53:27 -04:00
parent e8d5a06bc8
commit 9892b663d2
2 changed files with 29 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
project/src/backend.rs
View file

@ -54,6 +54,23 @@ impl Backend {
pub fn get_memberships(&self) -> Vec<String> {
self.memberships.clone()
}
/// Calculates the Prorate with the given parameters
///
/// Memberships need to be in the format of: _"MEMBERSHIPNAME ($PRI.CE)"_
///
/// # Arguments
/// * `current_membership` - The text content of what current membership you have
/// * `new_membership` - The text content of what new membership you're getting
/// * `last_billing` - The date of the last time the customer got billed _(mm/dd/yyyy)_
///
/// # Examples
/// ```rs
/// let result = calculator.start(
/// "Super ($41.99)".to_string(),
/// "Deluxe ($36.99)".to_string(),
/// "7/16/2025".to_string()
/// )?;
/// ```
pub fn calculator_start(
&self,
current_membership: String,

12
project/src/backend/calculator.rs
View file

@ -66,9 +66,21 @@ impl Calculator {
// Functions
/// Calculates the Prorate with the given parameters
///
/// Memberships need to be in the format of: _"MEMBERSHIPNAME ($PRI.CE)"_
///
/// # Arguments
/// * `current_membership` - The text content of what current membership you have
/// * `new_membership` - The text content of what new membership you're getting
/// * `last_billing` - The date of the last time the customer got billed _(mm/dd/yyyy)_
///
/// # Examples
/// ```rs
/// let result = calculator.start(
/// "Super ($41.99)".to_string(),
/// "Deluxe ($36.99)".to_string(),
/// "7/16/2025".to_string()
/// )?;
/// ```
pub fn start(
&self,
current_membership: String,