Skip to content

Commit a0d4828

Browse files
docs: flesh out some ack docs
1 parent d2d555c commit a0d4828

File tree

2 files changed

+14
-2
lines changed

2 files changed

+14
-2
lines changed

src/acknowledgement/core_types.rs

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,13 @@ impl License {
4949
#[non_exhaustive]
5050
pub enum LicenseType {
5151
/// Sublime's custom license
52+
///
53+
/// ```text
54+
/// Permission to copy, use, modify, sell and distribute this
55+
/// software is granted. This software is provided "as is" without
56+
/// express or implied warranty, and with no claim as to its
57+
/// suitability for any purpose.
58+
/// ```
5259
Sublime,
5360
/// [MIT License](https://choosealicense.com/licenses/mit/)
5461
Mit,
@@ -103,7 +110,10 @@ curation of said themes and syntaxes is taken from the
103110
impl Acknowledgements {
104111
/// Display the license information as Markdown
105112
///
106-
/// The output is roughly as follows
113+
/// _Note: A full set of acknowledgements is posted for each version at the URL returned by
114+
/// [`two_face::acknowledgement::url()`][crate::acknowledgement::url]_
115+
///
116+
/// The output looks roughly as follows
107117
///
108118
/// ```md
109119
/// Most of the code for generating both theme and syntax dumps along with the

src/acknowledgement/mod.rs

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,9 @@ pub fn listing() -> Acknowledgements {
2222

2323
/// Returns a link to a page listing acknowledgements for all syntax and theme definitions
2424
///
25-
/// Available without having to bundle all of the acknowledgement info in your binary
25+
/// Unlike the embedded acknowledgements which only include the licenses which _require_
26+
/// acknowledgement this listing contains _all_ of the licenses of the syntaxes and themes included
27+
/// with this crate. All without having to bundle the acknowledgement info into your final binary!
2628
///
2729
/// ```
2830
/// assert_eq!(

0 commit comments

Comments
 (0)