Update win_certificate_store.py

[lingfish]

Improvements to describe the different destination stores.

+label: docsite_pr

SUMMARY

The options provided weren't clear enough (for me anyway).

ISSUE TYPE

• Docs Pull Request

COMPONENT NAME

win_certificate_store

ANSIBLE VERSION

current

ADDITIONAL INFORMATION

None.

[ansibot]

cc @dagwieers @jborean93 @jhawkesworth @nitzmahone
click here for bot help

[ansibot]

The test ansible-test sanity --test ansible-doc --python 2.7 [explain] failed with 1 error:

lib/ansible/modules/windows/win_certificate_store.py:0:0: missing documentation (or could not parse documentation): expected string or buffer

The test ansible-test sanity --test ansible-doc --python 2.6 [explain] failed with 1 error:

lib/ansible/modules/windows/win_certificate_store.py:0:0: missing documentation (or could not parse documentation): expected string or buffer

The test ansible-test sanity --test ansible-doc --python 3.5 [explain] failed with 1 error:

lib/ansible/modules/windows/win_certificate_store.py:0:0: missing documentation (or could not parse documentation): expected string or bytes-like object

The test ansible-test sanity --test ansible-doc --python 3.6 [explain] failed with 1 error:

lib/ansible/modules/windows/win_certificate_store.py:0:0: missing documentation (or could not parse documentation): expected string or bytes-like object

The test ansible-test sanity --test ansible-doc --python 3.7 [explain] failed with 1 error:

lib/ansible/modules/windows/win_certificate_store.py:0:0: missing documentation (or could not parse documentation): expected string or bytes-like object

The test ansible-test sanity --test validate-modules [explain] failed with 8 errors:

lib/ansible/modules/windows/win_certificate_store.py:0:0: E305 DOCUMENTATION.options.store_name.description.1: expected str @ data['options']['store_name']['description'][1]. Got {'C(AddressBook)': 'The X.509 certificate store for other users'}
lib/ansible/modules/windows/win_certificate_store.py:0:0: E305 DOCUMENTATION.options.store_name.description.2: expected str @ data['options']['store_name']['description'][2]. Got {'C(AuthRoot)': 'The X.509 certificate store for third-party certificate authorities (CAs)'}
lib/ansible/modules/windows/win_certificate_store.py:0:0: E305 DOCUMENTATION.options.store_name.description.3: expected str @ data['options']['store_name']['description'][3]. Got {'C(CertificateAuthority)': 'The X.509 certificate store for intermediate certificate authorities (CAs)'}
lib/ansible/modules/windows/win_certificate_store.py:0:0: E305 DOCUMENTATION.options.store_name.description.4: expected str @ data['options']['store_name']['description'][4]. Got {'C(Disallowed)': 'The X.509 certificate store for revoked certificates'}
lib/ansible/modules/windows/win_certificate_store.py:0:0: E305 DOCUMENTATION.options.store_name.description.5: expected str @ data['options']['store_name']['description'][5]. Got {'C(My)': 'The X.509 certificate store for personal certificates'}
lib/ansible/modules/windows/win_certificate_store.py:0:0: E305 DOCUMENTATION.options.store_name.description.6: expected str @ data['options']['store_name']['description'][6]. Got {'C(Root)': 'The X.509 certificate store for trusted root certificate authorities (CAs)'}
lib/ansible/modules/windows/win_certificate_store.py:0:0: E305 DOCUMENTATION.options.store_name.description.7: expected str @ data['options']['store_name']['description'][7]. Got {'C(TrustedPeople)': 'The X.509 certificate store for directly trusted people and resources'}
lib/ansible/modules/windows/win_certificate_store.py:0:0: E305 DOCUMENTATION.options.store_name.description.8: expected str @ data['options']['store_name']['description'][8]. Got {'C(TrustedPublisher)': 'The X.509 certificate store for directly trusted publishers'}

click here for bot help

[jborean93]

Because you have : (with the space), you need to quote the entire line for it to be valid yaml.

Another option, instead of adding the description for each option is to just give a link to the Enum in the .net docs https://msdn.microsoft.com/en-us/library/system.security.cryptography.x509certificates.storename.aspx. I'll leave it up to you what you would like to have as I don't mind either way.

[lingfish]

Yep, ok sorry about that. I think I'll leave the (mostly won't change) text. MS have a nice habit of breaking their links.

[jborean93]

Backport PR to stable-2.5 #38927