Add_at_the_documentation_about_known_issues #1284
Conversation
AndreMarcel99
changed the title
AndreMarcel99
changed the title
AndreMarcel99
requested review from
fernandofloresg,
rexemin,
ddimatos,
ketankelkar and
richp405
| @@ -185,6 +185,9 @@ | |||
| the block will be overwritten on each iteration. | |||
| - When more then one block should be handled in a file you must change | |||
| the I(marker) per task. | |||
| - If using ZOAU version 1.3.0 and double quotes (") in the block argument, the module | |||
| will throw a false negative response. Follow up on the | |||
| L(issue in the collection's repository,https://github.com/ansible-collections/ibm_zos_core/issues/1258). | |||
There was a problem hiding this comment.
Perhaps the note here can be expanded upon to include some additional details. Maybe something like:
With ZOAU version 1.3.0, if double quotes (") are used in the I(block) parameter, the module
fails with an error message containing: 'return content is NOT in json format'. This is currently a false negative response, where the I(src) is changed, but an error is reported anyhow. Follow up on the issue tracked L(here,#1258).
Feel free to re-reword what I've got, my point is just to add more info about the behavior for the user.
plugins/modules/zos_lineinfile.py
Outdated
| @@ -195,6 +195,9 @@ | |||
| needs to be encoded, it should be cataloged first. | |||
| - For supported character sets used to encode data, refer to the | |||
| L(documentation,https://ibm.github.io/z_ansible_collections_doc/ibm_zos_core/docs/source/resources/character_set.html). | |||
| - When working with an MVS file and ZOAU version 1.3.0, combining C(regexp) | |||
There was a problem hiding this comment.
I'm not sure if MVS file is an official z/OS term, if it's data sets, maybe use data sets? Valid data sets are already defined above, so we probably don't need to re-specify them
When working with data sets and ZOAU version 1.3.0, combining ...
Also, "throw an error" is more of a developer-y word to me, maybe we can say the "module fails or something like that?
Maybe:
When working with ZOAU version 1.3.0, the module fails when C(src) is a data set and either C(insertafter) or C(insertbefore) is set in addition to C(regexp).
^ I like having the ZOAU version right at the beginning so if anyone is on a different version, they dont have to bother reading the rest of the sentence
fernandofloresg
added
the
Do not Merge
SUMMARY
Add in notes about documentation about known issues
ISSUE TYPE