Skip to content

Commit 0a65981

Browse files
committed
Modify comments for feed_filename to clarify default value and default behavior.
1 parent a53b59b commit 0a65981

File tree

2 files changed

+4
-2
lines changed

2 files changed

+4
-2
lines changed

Diff for: components/config/src/config/languages.rs

+2-1
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,8 @@ pub struct LanguageOptions {
1717
/// Whether to generate a feed for that language, defaults to `false`
1818
pub generate_feed: bool,
1919
/// The filename to use for feeds. Used to find the template, too.
20-
/// Defaults to "atom.xml", with "rss.xml" also having a template provided out of the box.
20+
/// Defaults to None, with "atom.xml" and "rss.xml" having templates provided out of the box.
21+
/// If None, site config feed filename is used.
2122
pub feed_filename: Option<String>,
2223
pub taxonomies: Vec<taxonomies::TaxonomyConfig>,
2324
/// Whether to generate search index for that language, defaults to `false`

Diff for: components/config/src/config/mod.rs

+2-1
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,8 @@ pub struct Config {
6666
/// The number of articles to include in the feed. Defaults to including all items.
6767
pub feed_limit: Option<usize>,
6868
/// The filename to use for feeds. Used to find the template, too.
69-
/// Defaults to "atom.xml", with "rss.xml" also having a template provided out of the box.
69+
/// Defaults to None, with "atom.xml" and "rss.xml" having templates provided out of the box.
70+
/// If None, "atom.xml" is used for feed. Defined by DEFAULT_FEED_FILENAME
7071
pub feed_filename: Option<String>,
7172
/// If set, files from static/ will be hardlinked instead of copied to the output dir.
7273
pub hard_link_static: bool,

0 commit comments

Comments
 (0)