[librsvg/svenfoo/librsvg-fix-new-clippy-warnings: 6/6] Slightly improve the docs for PathOrUrl




commit 523f5f0abe44e1b53803b38d5cf6538d8fd237df
Author: Federico Mena Quintero <federico gnome org>
Date:   Mon Feb 15 13:29:27 2021 -0600

    Slightly improve the docs for PathOrUrl

 src/c_api/handle.rs | 4 ++++
 1 file changed, 4 insertions(+)
---
diff --git a/src/c_api/handle.rs b/src/c_api/handle.rs
index f7b1cb21..147facd7 100644
--- a/src/c_api/handle.rs
+++ b/src/c_api/handle.rs
@@ -2131,6 +2131,10 @@ pub unsafe extern "C" fn rsvg_cleanup() {}
 /// `gio::File::new_for_path()` or `gio::File::new_for_uri()` as appropriate.
 ///
 /// This enum does the magic heuristics to figure this out.
+///
+/// The `from_os_str` version is for using the same logic on rsvg-convert's command-line
+/// arguments: we want `rsvg-convert http://example.com/foo.svg` to go to a URL, not to a
+/// local file with that name.
 #[derive(Clone, Debug)]
 pub enum PathOrUrl {
     Path(PathBuf),


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]