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

Fix heading line-lengths #49685

Merged
merged 2 commits into from Sep 18, 2018

Conversation

Projects
None yet
4 participants
@rallytime
Copy link
Contributor

commented Sep 17, 2018

This should clean up some of the warnings found by building the documentation:

/root/SaltStack/salt/doc/ref/pillar/all/index.rst:55:<autosummary>:1: WARNING: Unexpected section title or transition.

=================

I should check the doc build result before merging. I am not sure if I got all of them.

Fix heading line-lengths
This will clean up some of the warnings found by building the documentation:

```
/root/SaltStack/salt/doc/ref/pillar/all/index.rst:55:<autosummary>:1: WARNING: Unexpected section title or transition.

=================
```

@rallytime rallytime requested a review from saltstack/team-core as a code owner Sep 17, 2018

@salt-jenkins salt-jenkins requested a review from saltstack/team-suse Sep 17, 2018

@dwoz

dwoz approved these changes Sep 18, 2018

@isbm

isbm approved these changes Sep 18, 2018

@@ -1,7 +1,6 @@
# -*- coding: utf-8 -*-
'''
Execute a command and read the output as YAMLEX. The YAMLEX data is then
directly overlaid onto the minion's Pillar data
Execute a command and read the output as YAMLEX. The YAMLEX data is then directly overlaid onto the minion's Pillar data

This comment has been minimized.

Copy link
@DmitryKuzmenko

DmitryKuzmenko Sep 18, 2018

Contributor

I understand other changes but is there a reason to do this line 121 characters long? If there's any I'm ok.

This comment has been minimized.

Copy link
@rallytime

rallytime Sep 18, 2018

Author Contributor

There's a note a couple of lines down about this which gave me a clue:

# Don't "fix" the above docstring to put it on two lines, as the sphinx
# autosummary pulls only the first line for its description.

Perhaps however we don't need that long of a basic description. I can split that long line into two separate lines instead like other docs.

@rallytime rallytime merged commit 37cbd27 into saltstack:2017.7 Sep 18, 2018

4 of 10 checks passed

jenkins/pr/py2-centos-7 running py2-centos-7...
Details
jenkins/pr/py2-ubuntu-1604 running py2-ubuntu-1604...
Details
jenkins/pr/py2-windows-2016 running py2-windows-2016...
Details
jenkins/pr/py3-centos-7 running py3-centos-7...
Details
jenkins/pr/py3-ubuntu-1604 running py3-ubuntu-1604...
Details
jenkins/pr/py3-windows-2016 running py3-windows-2016...
Details
WIP ready for review
Details
continuous-integration/jenkins/pr-merge This commit looks good
Details
jenkins/pr/docs The docs job has passed
Details
jenkins/pr/lint The lint job has passed
Details

@rallytime rallytime deleted the rallytime:pillar-headings branch Sep 18, 2018

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.