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.

Sign up for GitHub

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

Jump to bottom

Fix code formatting in documentation of dconf.py #6538

Merged
merged 3 commits into from
May 20, 2023
Merged

Fix code formatting in documentation of dconf.py #6538

merged 3 commits into from
May 20, 2023

Conversation

beyimjan
Copy link
Contributor

@beyimjan beyimjan commented May 20, 2023 •
edited
Loading

SUMMARY

Here https://docs.ansible.com/ansible/latest/collections/community/general/dconf_module.html incorrect :code: syntax was used to enclose code snippets, which resulted in rendering issues.

ISSUE TYPE
  • Docs Pull Request
COMPONENT NAME

community.general.dconf module

@ansibullbot
Copy link
Collaborator

cc @azaghal
click here for bot help

@ansibullbot ansibullbot added docs docs_only module module new_contributor Help guide this first time contributor plugins plugin (any type) small_patch Hopefully easy to review labels May 20, 2023
felixfontein
felixfontein reviewed May 20, 2023
View reviewed changes
Copy link
Collaborator

@felixfontein felixfontein left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm, C(...) won't work either since C( stops parsing when the next ) shows up. I think for now it's best to not use formatting (and backport to older versions as well), and start using semantic markup on main and stable-7 (which allows to use V(...)) to fix this.

@felixfontein felixfontein added check-before-release PR will be looked at again shortly before release and merged if possible. backport-5 labels May 20, 2023
@felixfontein felixfontein mentioned this pull request May 20, 2023
Merged
@ansibullbot ansibullbot removed the small_patch Hopefully easy to review label May 20, 2023
@patchback patchback bot mentioned this pull request May 20, 2023
Merged
@felixfontein
Copy link
Collaborator

Darn, that was stupid... GitHub is sometimes trying to be too clever :D

@felixfontein felixfontein reopened this May 20, 2023
@felixfontein felixfontein merged commit 08377df into ansible-collections:main May 20, 2023
@patchback
Copy link

patchback bot commented May 20, 2023 •
edited
Loading

Backport to stable-5: 💚 backport PR created

✅ Backport PR branch: patchback/backports/stable-5/08377df7a5801b26fce498681180a23a2fdaeda3/pr-6538

Backported as #6541

🤖 @patchback
I'm built with octomachinery and
my source is open — https://github.com/sanitizers/patchback-github-app.

@felixfontein felixfontein removed the check-before-release PR will be looked at again shortly before release and merged if possible. label May 20, 2023
patchback bot pushed a commit that referenced this pull request May 20, 2023
@beyimjan @patchback
Fix code formatting in documentation of dconf.py (#6538)
f51ba67 
* Fix code formatting in documentation of dconf.py

* Update plugins/modules/dconf.py

Co-authored-by: Felix Fontein <[email protected]>

* Update plugins/modules/dconf.py

Co-authored-by: Felix Fontein <[email protected]>

---------

Co-authored-by: Felix Fontein <[email protected]>
(cherry picked from commit 08377df)
@patchback patchback bot mentioned this pull request May 20, 2023
Merged
@patchback
Copy link

patchback bot commented May 20, 2023 •
edited
Loading

Backport to stable-6: 💚 backport PR created

✅ Backport PR branch: patchback/backports/stable-6/08377df7a5801b26fce498681180a23a2fdaeda3/pr-6538

Backported as #6542

🤖 @patchback
I'm built with octomachinery and
my source is open — https://github.com/sanitizers/patchback-github-app.

@felixfontein
Copy link
Collaborator

@bimzhanovt thanks a lot for improving the docs!

patchback bot pushed a commit that referenced this pull request May 20, 2023
@beyimjan @patchback
Fix code formatting in documentation of dconf.py (#6538)
d116a46 
* Fix code formatting in documentation of dconf.py

* Update plugins/modules/dconf.py

Co-authored-by: Felix Fontein <[email protected]>

* Update plugins/modules/dconf.py

Co-authored-by: Felix Fontein <[email protected]>

---------

Co-authored-by: Felix Fontein <[email protected]>
(cherry picked from commit 08377df)
@patchback patchback bot mentioned this pull request May 20, 2023
Merged
@patchback
Copy link

patchback bot commented May 20, 2023 •
edited
Loading

Backport to stable-7: 💚 backport PR created

✅ Backport PR branch: patchback/backports/stable-7/08377df7a5801b26fce498681180a23a2fdaeda3/pr-6538

Backported as #6543

🤖 @patchback
I'm built with octomachinery and
my source is open — https://github.com/sanitizers/patchback-github-app.

patchback bot pushed a commit that referenced this pull request May 20, 2023
@beyimjan @patchback
Fix code formatting in documentation of dconf.py (#6538)
0662503 
* Fix code formatting in documentation of dconf.py

* Update plugins/modules/dconf.py

Co-authored-by: Felix Fontein <[email protected]>

* Update plugins/modules/dconf.py

Co-authored-by: Felix Fontein <[email protected]>

---------

Co-authored-by: Felix Fontein <[email protected]>
(cherry picked from commit 08377df)
@patchback patchback bot mentioned this pull request May 20, 2023
Merged
@beyimjan beyimjan deleted the patch-1 branch May 20, 2023 12:36
@felixfontein felixfontein mentioned this pull request May 20, 2023
Merged
felixfontein pushed a commit that referenced this pull request May 20, 2023
@patchback @beyimjan
[PR #6538/08377df7 backport][stable-5] Fix code formatting in documen…
cc52e19 
…tation of dconf.py (#6541)

Fix code formatting in documentation of dconf.py (#6538)

* Fix code formatting in documentation of dconf.py

* Update plugins/modules/dconf.py

Co-authored-by: Felix Fontein <[email protected]>

* Update plugins/modules/dconf.py

Co-authored-by: Felix Fontein <[email protected]>

---------

Co-authored-by: Felix Fontein <[email protected]>
(cherry picked from commit 08377df)

Co-authored-by: Tamerlan Bimzhanov <[email protected]>
felixfontein pushed a commit that referenced this pull request May 20, 2023
@patchback @beyimjan
[PR #6538/08377df7 backport][stable-7] Fix code formatting in documen…
f21f1cf 
…tation of dconf.py (#6543)

Fix code formatting in documentation of dconf.py (#6538)

* Fix code formatting in documentation of dconf.py

* Update plugins/modules/dconf.py

Co-authored-by: Felix Fontein <[email protected]>

* Update plugins/modules/dconf.py

Co-authored-by: Felix Fontein <[email protected]>

---------

Co-authored-by: Felix Fontein <[email protected]>
(cherry picked from commit 08377df)

Co-authored-by: Tamerlan Bimzhanov <[email protected]>
felixfontein pushed a commit that referenced this pull request May 20, 2023
@patchback @beyimjan
[PR #6538/08377df7 backport][stable-6] Fix code formatting in documen…
9b983fb 
…tation of dconf.py (#6542)

Fix code formatting in documentation of dconf.py (#6538)

* Fix code formatting in documentation of dconf.py

* Update plugins/modules/dconf.py

Co-authored-by: Felix Fontein <[email protected]>

* Update plugins/modules/dconf.py

Co-authored-by: Felix Fontein <[email protected]>

---------

Co-authored-by: Felix Fontein <[email protected]>
(cherry picked from commit 08377df)

Co-authored-by: Tamerlan Bimzhanov <[email protected]>
@patchback patchback bot mentioned this pull request May 29, 2023
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@felixfontein felixfontein felixfontein left review comments

Assignees
No one assigned
Labels
docs_only docs module module new_contributor Help guide this first time contributor plugins plugin (any type)
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@beyimjan @ansibullbot @felixfontein