Module documentation fails to parse

Archives Ansible Developer
1

Hi, I added a PR for a new module in -extras, but something is wrong in the documentation causing it to fail to parse. Can someone tell me what’s wrong?
https://github.com/tedder/ansible-modules-extras/blob/7d6c2e7d614aabe978905cee89e0c627634c2e6f/cloud/amazon/s3_sync.py

I would hop on IRC but I’m on the road and don’t have a bouncer.

2

Per one of the CI tasks (https://app.shippable.com/runs/58178ea3c202300e007006f1/17/console) there is some additional information as to what the issues are:

2016-10-31 18:36:28 ============================================================================
2016-10-31 18:36:28 ./cloud/amazon/s3_sync.py
2016-10-31 18:36:28 ============================================================================
2016-10-31 18:36:28 TRACE:
2016-10-31 18:36:28 while scanning for the next token
2016-10-31 18:36:28 found character ‘@’ that cannot start any token
2016-10-31 18:36:28 in “s3_sync.DOCUMENTATION”, line 80, column 9:
2016-10-31 18:36:28 author: @tedder
2016-10-31 18:36:28 ^
2016-10-31 18:36:28 TRACE:
2016-10-31 18:36:28 while parsing a flow mapping
2016-10-31 18:36:28 in “”, line 16, column 12:
2016-10-31 18:36:28 sample: [{
2016-10-31 18:36:28 ^
2016-10-31 18:36:28 expected ‘,’ or ‘}’, but got ‘’
2016-10-31 18:36:28 in “s3_sync.RETURN”, line 127, column 33:
2016-10-31 18:36:28 “local_etag”: ““fd215a4bb499fe74a85f2d11c2c5a82e””,
2016-10-31 18:36:28 ^
2016-10-31 18:36:28 ERROR: DOCUMENTATION is not valid YAML. Line 80 column 9
2016-10-31 18:36:28 ERROR: RETURN is not valid YAML. Line 127 column 33
2016-10-31 18:36:28 ERROR: indentation contains tabs. line 261 column 35

Past the above there may be more errors, but those are the current reasons for the invalid YAML.

3

Thanks. I wasn’t seeing the error in ansible-doc so I despaired. This helped me iterate and fix the various issues.