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

[BUG] Default values in docstring parameters have no space after parameter #57053

Open
oeuftete opened this issue May 2, 2020 · 3 comments
Open
Labels
Bug broken, incorrect, or confusing behavior Documentation Relates to Salt documentation severity-medium 3rd level, incorrect or bad functionality, confusing and lacks a work around time-estimate-sprint
Milestone

Comments

@oeuftete
Copy link
Contributor

oeuftete commented May 2, 2020

Description

salt/salt/modules/state.py

Lines 677 to 682 in 1340126

queue : False
Instead of failing immediately when another state run is in progress,
queue the new state run to begin running once the other has finished.
This option starts a new thread for each queued state run, so use this
option sparingly.

image

Expected behavior

There should be space and/or a delimiter between the parameter name and its default.

Versions Report

Master, 1340126 at time of reporting.

@oeuftete oeuftete added Documentation Relates to Salt documentation Bug broken, incorrect, or confusing behavior labels May 2, 2020
@oeuftete oeuftete added this to the Approved milestone May 2, 2020
@oeuftete
Copy link
Contributor Author

oeuftete commented May 2, 2020

It looks related to this Sphinx issue: sphinx-doc/sphinx#5976 , but that's already fixed in the release in use here.

@oeuftete
Copy link
Contributor Author

oeuftete commented May 2, 2020

Something like this fixes it, but may not be the right way to go about it:

diff --git a/doc/_themes/saltstack2/layout.html b/doc/_themes/saltstack2/layout.html
index 8149a53ee0..874d968c70 100644
--- a/doc/_themes/saltstack2/layout.html
+++ b/doc/_themes/saltstack2/layout.html
@@ -26,6 +26,7 @@
 
 {% set css_files = [
     '_static/css/core.min.css',
+    '_static/css/main.css',
     '_static/css/webhelp.min_v1.4.5.css',
 ] %}
 
diff --git a/doc/_themes/saltstack2/static/css/main.css b/doc/_themes/saltstack2/static/css/main.css
new file mode 100644
index 0000000000..16fffc59dc
--- /dev/null
+++ b/doc/_themes/saltstack2/static/css/main.css
@@ -0,0 +1,5 @@
+.classifier:before {
+    font-style: normal;
+    margin: 0.5em;
+    content: ":";
+}

image

@oeuftete
Copy link
Contributor Author

Still an issue as of now (998c382).

@barbaricyawps barbaricyawps added help-wanted Community help is needed to resolve this time-estimate-quick-fix severity-medium 3rd level, incorrect or bad functionality, confusing and lacks a work around time-estimate-sprint and removed help-wanted Community help is needed to resolve this time-estimate-quick-fix labels Mar 21, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Bug broken, incorrect, or confusing behavior Documentation Relates to Salt documentation severity-medium 3rd level, incorrect or bad functionality, confusing and lacks a work around time-estimate-sprint
Projects
None yet
Development

No branches or pull requests

2 participants