Modify comments for feed_filename to clarify default value and defaul…

…t behavior.
getzola · Jan 23, 2024 · 0a65981 · 0a65981
1 parent a53b59b
commit 0a65981
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 2 deletions.
diff --git a/components/config/src/config/languages.rs b/components/config/src/config/languages.rs
@@ -17,7 +17,8 @@ pub struct LanguageOptions {
     /// Whether to generate a feed for that language, defaults to `false`
     pub generate_feed: bool,
     /// The filename to use for feeds. Used to find the template, too.
-    /// Defaults to "atom.xml", with "rss.xml" also having a template provided out of the box.
+    /// Defaults to None, with "atom.xml" and "rss.xml" having templates provided out of the box.
+    /// If None, site config feed filename is used.
     pub feed_filename: Option<String>,
     pub taxonomies: Vec<taxonomies::TaxonomyConfig>,
     /// Whether to generate search index for that language, defaults to `false`

diff --git a/components/config/src/config/mod.rs b/components/config/src/config/mod.rs
@@ -66,7 +66,8 @@ pub struct Config {
     /// The number of articles to include in the feed. Defaults to including all items.
     pub feed_limit: Option<usize>,
     /// The filename to use for feeds. Used to find the template, too.
-    /// Defaults to "atom.xml", with "rss.xml" also having a template provided out of the box.
+    /// Defaults to None, with "atom.xml" and "rss.xml" having templates provided out of the box.
+    /// If None, "atom.xml" is used for feed.  Defined by DEFAULT_FEED_FILENAME
     pub feed_filename: Option<String>,
     /// If set, files from static/ will be hardlinked instead of copied to the output dir.
     pub hard_link_static: bool,