diff --git a/src/acknowledgement/core_types.rs b/src/acknowledgement/core_types.rs index f77d528..c996a0c 100644 --- a/src/acknowledgement/core_types.rs +++ b/src/acknowledgement/core_types.rs @@ -49,6 +49,13 @@ impl License { #[non_exhaustive] pub enum LicenseType { /// Sublime's custom license + /// + /// ```text + /// Permission to copy, use, modify, sell and distribute this + /// software is granted. This software is provided "as is" without + /// express or implied warranty, and with no claim as to its + /// suitability for any purpose. + /// ``` Sublime, /// [MIT License](https://choosealicense.com/licenses/mit/) Mit, @@ -103,7 +110,10 @@ curation of said themes and syntaxes is taken from the impl Acknowledgements { /// Display the license information as Markdown /// - /// The output is roughly as follows + /// _Note: A full set of acknowledgements is posted for each version at the URL returned by + /// [`two_face::acknowledgement::url()`][crate::acknowledgement::url]_ + /// + /// The output looks roughly as follows /// /// ```md /// Most of the code for generating both theme and syntax dumps along with the diff --git a/src/acknowledgement/mod.rs b/src/acknowledgement/mod.rs index ae42b84..d9783a5 100644 --- a/src/acknowledgement/mod.rs +++ b/src/acknowledgement/mod.rs @@ -22,7 +22,9 @@ pub fn listing() -> Acknowledgements { /// Returns a link to a page listing acknowledgements for all syntax and theme definitions /// -/// Available without having to bundle all of the acknowledgement info in your binary +/// Unlike the embedded acknowledgements which only include the licenses which _require_ +/// acknowledgement this listing contains _all_ of the licenses of the syntaxes and themes included +/// with this crate. All without having to bundle the acknowledgement info into your final binary! /// /// ``` /// assert_eq!(