Skip to content

Conversation

@NiceTSY
Copy link
Contributor

@NiceTSY NiceTSY commented Dec 17, 2025

Pull Request

Purpose

Add Audio Description CFs to the guide and implement them into the French Guide.

Approach

Open Questions and Pre-Merge TODOs

Requirements

Summary by Sourcery

Add a new Audio Description custom format and integrate it into the Radarr and Sonarr French quality profile guides.

New Features:

  • Introduce a WiTH AD (Audio Description) custom format for Radarr and Sonarr, including shared description content and JSON config placeholders.

Documentation:

  • Document the WiTH AD custom format in the Radarr and Sonarr custom format collections.
  • Extend the French Radarr and Sonarr quality profile guides (EN/FR) with a new section explaining how to use the Audio Description custom format for visually impaired–friendly releases.

@NiceTSY NiceTSY requested a review from a team December 17, 2025 14:39
@NiceTSY NiceTSY self-assigned this Dec 17, 2025
@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Dec 17, 2025

Reviewer's Guide

Adds a new "WiTH AD" (Audio Description) custom format for both Radarr and Sonarr, wires it into the French setup guides (EN/FR), and introduces shared description and JSON definition files to support it.

Flow diagram for WiTH AD Audio Description CF documentation wiring

flowchart TD
    subgraph CF_Definition
      AD_Desc[with-ad_md\nincludes/cf-descriptions/with-ad.md]
      AD_Radarr_JSON[with-ad_json\ndocs/json/radarr/cf/with-ad.json]
      AD_Sonarr_JSON[with-ad_json\ndocs/json/sonarr/cf/with-ad.json]
    end

    subgraph CF_Collections
      Radarr_CF_Page[Radarr_collection_of_custom_formats_md]
      Sonarr_CF_Page[Sonarr_collection_of_custom_formats_md]
    end

    subgraph French_Guides
      Radarr_FR_EN[radarr-setup-quality-profiles-french-en_md]
      Radarr_FR_FR[radarr-setup-quality-profiles-french-fr_md]
      Sonarr_FR_EN[sonarr-setup-quality-profiles-french-en_md]
      Sonarr_FR_FR[sonarr-setup-quality-profiles-french-fr_md]

      Radarr_AD_EN[radarr-french-audio-description-en_md]
      Radarr_AD_FR[radarr-french-audio-description-fr_md]
      Sonarr_AD_EN[sonarr-french-audio-description-en_md]
      Sonarr_AD_FR[sonarr-french-audio-description-fr_md]
    end

    AD_Desc --> Radarr_CF_Page
    AD_Radarr_JSON --> Radarr_CF_Page

    AD_Desc --> Sonarr_CF_Page
    AD_Sonarr_JSON --> Sonarr_CF_Page

    Radarr_FR_EN --> Radarr_AD_EN
    Radarr_FR_FR --> Radarr_AD_FR
    Sonarr_FR_EN --> Sonarr_AD_EN
    Sonarr_FR_FR --> Sonarr_AD_FR

    Radarr_AD_EN --> Radarr_CF_Page
    Radarr_AD_FR --> Radarr_CF_Page
    Sonarr_AD_EN --> Sonarr_CF_Page
    Sonarr_AD_FR --> Sonarr_CF_Page
Loading

File-Level Changes

Change Details Files
Expose new WiTH AD custom format in Radarr and Sonarr CF collection docs.
  • Extend Radarr custom formats index table with a WiTH AD anchor entry.
  • Add a WiTH AD section to the Radarr CF collection that includes a shared description and the Radarr JSON include.
  • Extend Sonarr custom formats index table with a WiTH AD anchor entry.
  • Add a WiTH AD section to the Sonarr CF collection that includes a shared description and the Sonarr JSON include.
docs/Radarr/Radarr-collection-of-custom-formats.md
docs/Sonarr/sonarr-collection-of-custom-formats.md
Integrate Audio Description guidance into French Radarr and Sonarr quality profile guides (EN and FR variants).
  • Include a new Audio Description partial in the English Radarr French guide after the audio version section.
  • Include a new Audio Description partial in the French Radarr French guide after the audio version section.
  • Include a new Audio Description partial in the English Sonarr French guide after the audio version section.
  • Include a new Audio Description partial in the French Sonarr French guide after the audio version section.
docs/Radarr/radarr-setup-quality-profiles-french-en.md
docs/Radarr/radarr-setup-quality-profiles-french-fr.md
docs/Sonarr/sonarr-setup-quality-profiles-french-en.md
docs/Sonarr/sonarr-setup-quality-profiles-french-fr.md
Add reusable Audio Description explanation partials for Radarr and Sonarr French guides (EN/FR).
  • Create English Radarr Audio Description partial explaining AD releases and how to score the CF, using radarr with-ad template variables.
  • Create French Radarr Audio Description partial with equivalent explanation and radarr with-ad template variables.
  • Create English Sonarr Audio Description partial explaining AD releases and how to score the CF, using sonarr with-ad template variables.
  • Create French Sonarr Audio Description partial with equivalent explanation and sonarr with-ad template variables.
includes/french-guide/radarr-french-audio-description-en.md
includes/french-guide/radarr-french-audio-description-fr.md
includes/french-guide/sonarr-french-audio-description-en.md
includes/french-guide/sonarr-french-audio-description-fr.md
Add shared Audio Description CF description fragment.
  • Introduce shared with-ad markdown fragment describing Audio Description and linking to Wikipedia, to be reused by Radarr/Sonarr CF sections.
includes/cf-descriptions/with-ad.md
Stub JSON definitions for the new WiTH AD custom formats.
  • Add JSON file for Radarr WiTH AD custom format (content not shown in diff).
  • Add JSON file for Sonarr WiTH AD custom format (content not shown in diff).
docs/json/radarr/cf/with-ad.json
docs/json/sonarr/cf/with-ad.json

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@github-actions
Copy link
Contributor

@NiceTSY your pull request title "Feat (starr french): add Audio Description (AD) CF" does not conform to our naming conventions.

Please update the title to match the pattern: "feat|build|chore|style|fix|update|ci(<area>): <description>

You can check your title at this regex101 link."

@github-actions github-actions bot added Area: Sonarr Sonarr Related Area: Radarr Radarr Related Area: Backend Backend Changes, not related to a specific section Area: Starr Custom Formats Issue is related to custom formats labels Dec 17, 2025
Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey there - I've reviewed your changes - here's some feedback:

  • In the new English audio description includes, there are a couple of small phrasing issues that could be cleaned up for clarity, e.g. change “which is way for visually impaired people to enjoy their media” to “which is a way for visually impaired people to enjoy their media” and “and not be confused with advertisements as they are not” to something like “and should not be confused with advertisements.”
  • In the French audio description includes, there are some minor grammar/spelling issues worth fixing: e.g. “ceci ne doit pas être confondus” should agree in number (“confondue/confondues”) and “possèdant” should be “possédant.”
Prompt for AI Agents
Please address the comments from this code review:

## Overall Comments
- In the new English audio description includes, there are a couple of small phrasing issues that could be cleaned up for clarity, e.g. change “which is way for visually impaired people to enjoy their media” to “which is a way for visually impaired people to enjoy their media” and “and not be confused with advertisements as they are not” to something like “and should not be confused with advertisements.”
- In the French audio description includes, there are some minor grammar/spelling issues worth fixing: e.g. “ceci ne doit pas être confondus” should agree in number (“confondue/confondues”) and “possèdant” should be “possédant.”

## Individual Comments

### Comment 1
<location> `includes/french-guide/radarr-french-audio-description-en.md:4` </location>
<code_context>
+<!-- markdownlint-disable MD041-->
+??? abstract "Audio Description - [Click to show/hide]"
+
+    Some releases are now available with Audio Description, which is way for visually impaired people to enjoy their media.
+    Those are flagged `WiTH.AD` or just `AD`, and not be confused with advertisements as they are not.
+
</code_context>

<issue_to_address>
**issue (typo):** Fix grammar in 'which is way' phrase.

Change this to: `which is a way for visually impaired people to enjoy their media.` to fix the grammar.

```suggestion
    Some releases are now available with Audio Description, which is a way for visually impaired people to enjoy their media.
```
</issue_to_address>

### Comment 2
<location> `includes/french-guide/radarr-french-audio-description-en.md:7` </location>
<code_context>
+    Some releases are now available with Audio Description, which is way for visually impaired people to enjoy their media.
+    Those are flagged `WiTH.AD` or just `AD`, and not be confused with advertisements as they are not.
+
+    If you want to prefer those for any reasons, please add the following CF with a score of `101`. You can still use it for information if you decide to not score it.
+
+    | Custom Format                                                                                 | Trash ID                                  |
</code_context>

<issue_to_address>
**suggestion (typo):** Adjust 'for any reasons' to standard phrasing.

Change 'for any reasons' to 'for any reason' for more natural phrasing.

```suggestion
    If you want to prefer those for any reason, please add the following CF with a score of `101`. You can still use it for information if you decide to not score it.
```
</issue_to_address>

### Comment 3
<location> `includes/french-guide/sonarr-french-audio-description-en.md:4` </location>
<code_context>
+<!-- markdownlint-disable MD041-->
+??? abstract "Audio Description - [Click to show/hide]"
+
+    Some releases are now available with Audio Description, which is way for visually impaired people to enjoy their media.
+    Those are flagged `WiTH.AD` or just `AD`, and not be confused with advertisements as they are not.
+
</code_context>

<issue_to_address>
**issue (typo):** Fix grammar in 'which is way' phrase (Sonarr EN).

Change the phrase to: "which is a way for visually impaired people to enjoy their media."

```suggestion
    Some releases are now available with Audio Description, which is a way for visually impaired people to enjoy their media.
```
</issue_to_address>

### Comment 4
<location> `includes/french-guide/sonarr-french-audio-description-en.md:7` </location>
<code_context>
+    Some releases are now available with Audio Description, which is way for visually impaired people to enjoy their media.
+    Those are flagged `WiTH.AD` or just `AD`, and not be confused with advertisements as they are not.
+
+    If you want to prefer those for any reasons, please add the following CF with a score of `101`. You can still use it for information if you decide to not score it.
+
+    | Custom Format                                                                                 | Trash ID                                  |
</code_context>

<issue_to_address>
**suggestion (typo):** Adjust 'for any reasons' to standard phrasing (Sonarr EN).

Here too, please use 'for any reason' instead of 'for any reasons' for more natural phrasing.

```suggestion
    If you want to prefer those for any reason, please add the following CF with a score of `101`. You can still use it for information if you decide to not score it.
```
</issue_to_address>

### Comment 5
<location> `includes/french-guide/radarr-french-audio-description-fr.md:5` </location>
<code_context>
+??? abstract "Audio Description - [Click to show/hide]"
+
+    Certaines releases sont maintenant disponibles avec un canal d'Audio Description, ceci afin de rendre un média accessible aux personnes aveugles ou malvoyantes.
+    Celles-ci sont marquées avec `WiTH.AD` ou `AD`, ceci ne doit pas être confondus avec un média possèdant des pubs (advertisements ou ads en anglais).
+
+    Si vous souhaitez préférer ce type de releases, merci d'ajouter le CF suivant avec un score de `101`. Vous pouvez tout aussi l'utiliser mais à titre informatif sans le scorer.
</code_context>

<issue_to_address>
**issue (typo):** Fix agreement and spelling in French sentence.

Two minor fixes: (1) agreement: either "Ceci ne doit pas être confondu" or better match the plural subject with "Celles-ci ne doivent pas être confondues avec…"; (2) spelling: "possèdant" → "possédant".

```suggestion
    Celles-ci sont marquées avec `WiTH.AD` ou `AD`, celles-ci ne doivent pas être confondues avec un média possédant des pubs (advertisements ou ads en anglais).
```
</issue_to_address>

### Comment 6
<location> `includes/french-guide/sonarr-french-audio-description-fr.md:5` </location>
<code_context>
+??? abstract "Audio Description - [Click to show/hide]"
+
+    Certaines releases sont maintenant disponibles avec un canal d'Audio Description, ceci afin de rendre un média accessible aux personnes aveugles ou malvoyantes.
+    Celles-ci sont marquées avec `WiTH.AD` ou `AD`, ceci ne doit pas être confondus avec un média possèdant des pubs (advertisements ou ads en anglais).
+
+    Si vous souhaitez préférer ce type de releases, merci d'ajouter le CF suivant avec un score de `101`. Vous pouvez tout aussi l'utiliser mais à titre informatif sans le scorer.
</code_context>

<issue_to_address>
**issue (typo):** Correct French agreement and accent in Sonarr FR sentence.

As in the Radarr FR file, please update to: `Celles-ci ne doivent pas être confondues avec un média possédant des pubs…` to fix both agreement (`confondus``confondues`) and spelling (`possèdant``possédant`).

```suggestion
    Celles-ci sont marquées avec `WiTH.AD` ou `AD`, ceci ne doivent pas être confondues avec un média possédant des pubs (advertisements ou ads en anglais).
```
</issue_to_address>

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@github-actions
Copy link
Contributor

Deploying with ⚡ Cloudflare Pages

Latest commit:b69e4d21f569c260bf46cf00096ba8642b3b5319
Status: ✅  Deploy successful!
Preview URL:https://9351c6a9.trash-guides-6xu.pages.dev
Branch Preview URL:https://pr-2569.trash-guides-6xu.pages.dev

@NiceTSY NiceTSY changed the title Feat (starr french): add Audio Description (AD) CF feat(starr-french): add Audio Description (AD) CF Dec 17, 2025
@github-actions
Copy link
Contributor

Deploying with ⚡ Cloudflare Pages

Latest commit:27d4e24456af247c397e0bc8e2162ddcfa2418d8
Status: ✅  Deploy successful!
Preview URL:https://51af0c03.trash-guides-6xu.pages.dev
Branch Preview URL:https://pr-2569.trash-guides-6xu.pages.dev

@@ -0,0 +1,17 @@
{
"trash_id": "44ccbcbc74506f208973e1463b11705f",
"trash_regex": "https://regex101.com/r/GCIcFI",
Copy link
Contributor

@SeiyaGame SeiyaGame Dec 20, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It’s just missing the ignore-case flag in the trash_regex. That's not very importante ahah (MULTi can also be MULTI)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Area: Backend Backend Changes, not related to a specific section Area: Radarr Radarr Related Area: Sonarr Sonarr Related Area: Starr Custom Formats Issue is related to custom formats

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants