Skip to content

Commit 097ac62

Browse files
committed
Add format comment to InitializationOptions::with_license
1 parent 606b584 commit 097ac62

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

rust/src/headless.rs

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -98,6 +98,11 @@ impl InitializationOptions {
9898
}
9999

100100
/// A license to override with, you can use this to make sure you initialize with a specific license.
101+
///
102+
/// This takes the form of a JSON array. The string should be formed like:
103+
/// ```json
104+
/// [{ /* json object with license data */ }]
105+
/// ```
101106
pub fn with_license(mut self, license: impl Into<String>) -> Self {
102107
self.license = Some(license.into());
103108
self

0 commit comments

Comments
 (0)