You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
ansible/docs/docsite/rst/porting_guides
Sam Doran 2743ea1e69
[stable-2.11] Add porting guide and documentation for changes to argument spec validation (#74268) (#74353)
* Add ArgumentSpecValidator to docs
* Improve docs for ArgumentSpecValidator
* Document removal of private methods

* Update module_utils documentation
    - Add docs for argument spec classes as well as validation and parameters files.
    - preserve the order in the source for errors.py
    - document DEFAULT_TYPE_VALIDATORS so it can be referenced elsewhere
    - fix automodule directive for validation.py

* Update docs in arg_spec and paremeters
    - This improves the generated documentation.

* Document breaking changes in porting guide.
* Update formatting in porting guide and add a Deprecated section
* Fine tune module_utils documentation

* Move instance docstring to the __init__ method
  Remove optional description since it fails the sanity test and I am not 100% it is valid anyway.

* Remove incorrect parameter from docstring
  This was changed a while ago but wasn't removed from the docstring.

* Use attr rather than attribute
  The py:attribute: domain only exists in newer Sphinx >= 3.1.

* Improve documentation on exceptions
* Final pass
    - use args/kwargs instead of param
    - fix formatting errors that didn't display examples correctly
    - format TypeErrors so they are referenced as classes
    - specify complex types
(cherry picked from commit 2cbfd1e350)

Co-authored-by: Sam Doran <sdoran@redhat.com>
5 years ago
..
core_porting_guides.rst Split Ansible docs from core docs (#73616) 5 years ago
porting_guide_2.0.rst Wording changes to docs (#70082) 5 years ago
porting_guide_2.3.rst Fix typos (#72072) 5 years ago
porting_guide_2.4.rst restore TOC links to old porting guides (#64395) 6 years ago
porting_guide_2.5.rst Docsite: replace Latin phrases to English (#71588) 5 years ago
porting_guide_2.6.rst lineinfile note belongs in changelog for 2.6, not 2.7 (#45517) 7 years ago
porting_guide_2.7.rst Intersphinx (#68090) 6 years ago
porting_guide_2.8.rst Update porting_guide_2.8.rst (#72041) 5 years ago
porting_guide_2.9.rst [docs] add porting guide for DNF GPG validation (#71640) 5 years ago
porting_guide_2.10.rst Update 2.10 porting guide to include module index (#73615) 5 years ago
porting_guide_3.rst Update the porting guide for a new ansible version (#74073) 5 years ago
porting_guide_4.rst [backport][Docs] Docs backportapalooza1 (#74355) 5 years ago
porting_guide_base_2.10.rst Remove ansible-galaxy login (#72288) 5 years ago
porting_guide_core_2.11.rst [stable-2.11] Add porting guide and documentation for changes to argument spec validation (#74268) (#74353) 5 years ago
porting_guides.rst Porting guide changes when adding a new ansible release 5 years ago