Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

📝 [#43] Update documentation for setup-configuration #47

Merged
merged 3 commits into from
Feb 10, 2025

Conversation

stevenbal
Copy link
Collaborator

@stevenbal stevenbal commented Feb 7, 2025

Fixes #43

Changes

  • Update documentation for setup-configuration

Built docs can be viewed at: https://referentielijsten-api--47.org.readthedocs.build/en/47/installation/setup_configuration.html

@codecov-commenter
Copy link

codecov-commenter commented Feb 7, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.45%. Comparing base (5ff16d7) to head (ce9f42f).

Additional details and impacted files
@@           Coverage Diff           @@
##           master      #47   +/-   ##
=======================================
  Coverage   92.45%   92.45%           
=======================================
  Files          54       54           
  Lines        1047     1047           
=======================================
  Hits          968      968           
  Misses         79       79           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@stevenbal stevenbal force-pushed the feature/43-setup-config-docs branch from b72e2ca to 889d3a2 Compare February 7, 2025 15:53
setup_configuraiton
setup_configuration
Copy link
Contributor

Choose a reason for hiding this comment

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

Misspelled it lol

Comment on lines -15 to -17
.. warning:: This command is declarative - if configuration is manually changed after
running the command and you then run the exact same command again, the manual
changes will be reverted.
Copy link
Contributor

Choose a reason for hiding this comment

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

Should this warning be added back in?

Would that need to be in setup config itself?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

The warning is part of the general docs that are linked to: https://django-setup-configuration.readthedocs.io/en/0.7.0/quickstart.html#command-usage

image

@stevenbal stevenbal force-pushed the feature/43-setup-config-docs branch from 889d3a2 to ce9f42f Compare February 10, 2025 16:03
@stevenbal stevenbal merged commit 5f603f1 into master Feb 10, 2025
14 checks passed
@stevenbal stevenbal deleted the feature/43-setup-config-docs branch February 10, 2025 16:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Rewrite setup_configuration documentation with YAML example directive
3 participants