django-waffle icon indicating copy to clipboard operation
django-waffle copied to clipboard

Update the docs with explicit unittest to clarify usage of flag attribute everyone

Open imohib opened this issue 10 months ago • 1 comments

For more context, please refer to #561. Basically, current version of the docs incorrectly suggests that setting waffle flag attribute everyone overrides all the other setting unless set to Unknown (i.e. None).

image

Proposed changes in this PR:

  1. Fixes the docs re: incorrect usage of the waffle flag attribute everyone.
  2. Adds testcase WaffleFlagEveryoneSettingTests to prevent breaking changes and makes the behaviour explicit
  3. Fixes the warning - "django-waffle/docs/starting/installation.rst:54: WARNING: Explicit markup ends without a blank line; unexpected unindent."

imohib avatar Jun 07 '25 06:06 imohib

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Please upload report for BASE (master@9ae9b68). Learn more about missing BASE report.

Additional details and impacted files
@@            Coverage Diff            @@
##             master     #562   +/-   ##
=========================================
  Coverage          ?   95.83%           
=========================================
  Files             ?       36           
  Lines             ?     2474           
  Branches          ?        0           
=========================================
  Hits              ?     2371           
  Misses            ?      103           
  Partials          ?        0           

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

:rocket: New features to boost your workflow:
  • :snowflake: Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • :package: JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

codecov[bot] avatar Jun 07 '25 06:06 codecov[bot]