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

Update generator.py documentation #65573

Merged
merged 1 commit into from Dec 10, 2019
Merged

Update generator.py documentation #65573

merged 1 commit into from Dec 10, 2019

Conversation

joej164
Copy link
Contributor

@joej164 joej164 commented Dec 5, 2019

SUMMARY
  • Removed the dashes and replaced with underscores to avoid the DEPRECATION WARNING below when it's ran
  • Added a reminder to add the plugin to the ansible.cfg file as it's not enabled by default
  • Added an example of how to use the code in the file comments
[DEPRECATION WARNING]: The TRANSFORM_INVALID_GROUP_CHARS settings is set to allow bad characters in group 
names by default, this will change, but still be user configurable on deprecation. This feature will be 
removed in version 2.10. Deprecation warnings can be disabled by setting deprecation_warnings=False in 
ansible.cfg.
[WARNING]: Invalid characters were found in group names but not replaced, use -vvvv to see details
ISSUE TYPE
  • Docs Pull Request

+label: docsite_pr

SUMMARY
ISSUE TYPE
  • Bugfix Pull Request
  • Docs Pull Request
  • Feature Pull Request
  • New Module Pull Request
COMPONENT NAME
ADDITIONAL INFORMATION

##### SUMMARY
- Removed the dashes and replaced with underscores to  avoid the `DEPRECATION WARNING` below when it's ran
- Added a reminder to add the plugin to the ansible.cfg file as it's not enabled by default
- Added an example of how to use the code in the file comments

```
[DEPRECATION WARNING]: The TRANSFORM_INVALID_GROUP_CHARS settings is set to allow bad characters in group 
names by default, this will change, but still be user configurable on deprecation. This feature will be 
removed in version 2.10. Deprecation warnings can be disabled by setting deprecation_warnings=False in 
ansible.cfg.
[WARNING]: Invalid characters were found in group names but not replaced, use -vvvv to see details
```


##### ISSUE TYPE
- Docs Pull Request

+label: docsite_pr
@ansibot ansibot added affects_2.10 This issue/PR affects Ansible v2.10 community_review In order to be merged, this PR must follow the community review workflow. docs This issue/PR relates to or includes documentation. needs_triage Needs a first human triage before being processed. new_contributor This PR is the first contribution by a new community member. support:community This issue/PR relates to code supported by the Ansible community. labels Dec 5, 2019
@samccann samccann removed the needs_triage Needs a first human triage before being processed. label Dec 10, 2019
@samccann samccann merged commit d9f0703 into ansible:devel Dec 10, 2019
@samccann
Copy link
Contributor

Thanks @joej164 for the Ansible documentation fix.

anshulbehl pushed a commit to anshulbehl/ansible that referenced this pull request Dec 10, 2019
@ansible ansible locked and limited conversation to collaborators Jan 7, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
affects_2.10 This issue/PR affects Ansible v2.10 community_review In order to be merged, this PR must follow the community review workflow. docs This issue/PR relates to or includes documentation. new_contributor This PR is the first contribution by a new community member. support:community This issue/PR relates to code supported by the Ansible community.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants