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

Atributes documenation in most steps appear garbled #8085

Closed
stscijgbot-jp opened this issue Nov 25, 2023 · 5 comments · Fixed by #8101
Closed

Atributes documenation in most steps appear garbled #8085

stscijgbot-jp opened this issue Nov 25, 2023 · 5 comments · Fixed by #8101

Comments

@stscijgbot-jp
Copy link
Collaborator

Issue JP-3471 was created on JIRA by Rosa Diaz:

I found what appears to be a bug, but probably a change, in the way Sphinx is pulling the triple quoted comments from the "Attributes Documentation" for many of the steps. It is adding returns and spaces literal, making this section almost unreadable. 

Examples are these two cases, but there are many more.

@stscijgbot-jp
Copy link
Collaborator Author

Comment by Howard Bushouse on JIRA:

Rosa Diaz are you referring to the mish-mash of text in the list of entries in the "spec" block on each page?

@stscijgbot-jp
Copy link
Collaborator Author

stscijgbot-jp commented Nov 27, 2023

Comment by Rosa Diaz on JIRA:

Yes, that is correct. I attached a screenshot.

@stscijgbot-jp
Copy link
Collaborator Author

Comment by Howard Bushouse on JIRA:

Fixed by #8101

@stscijgbot-jp
Copy link
Collaborator Author

Comment by Rosa Diaz on JIRA:

Looks good to me. Thanks for fixing it!

@stscijgbot-jp
Copy link
Collaborator Author

Comment by David Law on JIRA:

Sound like this is fixed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant