Some documentation

Author: loganintech

src/cli.rs

@@ -6,13 +6,15 @@ use crate::provider::{
 };
 use clap::{App, AppSettings, Arg, ArgMatches};
 
+/// Enumerates the subcommand provider options available from subcommands.
 pub enum Gitpo<'a> {
     Github(GithubArgs<'a>),
     Gitlab(GitlabArgs<'a>),
     BitBucket(BitbucketArgs<'a>),
 }
 
 impl<'a> Gitpo<'a> {
+    /// from_matches constructs a subcommand config from the selected subcommand.
     pub fn from_matches(matches: &'a ArgMatches) -> Gitpo<'a> {
         match matches.subcommand_name() {
             Some("github") => Gitpo::Github(github::from_matches(
@@ -28,6 +30,9 @@ impl<'a> Gitpo<'a> {
         }
     }
 
+    /// as_provider
+    ///
+    /// Returns self as a reference to a Provider
     pub fn as_provider(&self) -> &dyn Provider {
         match self {
             Gitpo::Github(x) => x as &Provider,
@@ -37,6 +42,7 @@ impl<'a> Gitpo<'a> {
     }
 }
 
+/// ## Returns highest-level clap app.
 pub fn get_app() -> App<'static, 'static> {
     App::new("Git Publish")
         .global_setting(AppSettings::ColorAuto)

src/provider/mod.rs

@@ -2,10 +2,16 @@ pub mod bitbucket;
 pub mod github;
 pub mod gitlab;
 
+/// Provider outlines the requirements for a provider
 pub trait Provider {
+    ///A JSON payload to send to the provider's endpoint
     fn payload(&self) -> String;
+    ///The endpoint to send the POST, usually the form of api.___.com
     fn endpoint(&self) -> String;
-    fn extract_url(&self, src: &reqwest::header::HeaderMap) -> String;
+    /// A method to extract the remote url from the response headers.
+    fn extract_url(&self, _: &reqwest::header::HeaderMap) -> String;
+    /// The response token formatted as the request body.
     fn token(&self) -> String;
+    /// The response header key. Like `Authorization` or `Bearer`
     fn auth_header(&self) -> String;
 }