Apply suggestions from code review

Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca>
withastro · Mar 8, 2023 · 2651581 · 2651581
1 parent 082d7c2
commit 2651581
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 5 deletions.
diff --git a/.changeset/popular-rules-divide.md b/.changeset/popular-rules-divide.md
@@ -4,7 +4,6 @@
 
 Added `trailingSlash` option, to control whether the emitted URLs should have the trailing slash.
 
-The new option is optional.
 
 ```js
 import rss from '@astrojs/rss';

diff --git a/packages/astro-rss/README.md b/packages/astro-rss/README.md
@@ -73,8 +73,8 @@ export function get(context) {
     customData: '<language>en-us</language>',
     // (optional) add arbitrary metadata to opening <rss> tag
     xmlns: { h: 'http://www.w3.org/TR/html4/' },
-    // (optional) add or not the trailing slash
-    trailingSlash: "never"
+    // (optional) add trailing slashes to URLs (default: true)
+    trailingSlash: false
   });
 }
 ```
@@ -240,8 +240,7 @@ export async function get(context) {
 Type: `boolean (optional)`
 Default: "always"
 
-By default, the library will add trailing slashes to the emitted URLs. To change this behaviour,
-you use this option, by passing the value `false`.
+By default, the library will add trailing slashes to the emitted URLs. To prevent this behavior, add `trailingSlash: false` to the `rss` function.
 
 ```js
 import rss from '@astrojs/rss';