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

Formatting of bulleted items in docstrings #825

Closed
cormullion opened this issue Apr 14, 2021 · 2 comments
Closed

Formatting of bulleted items in docstrings #825

cormullion opened this issue Apr 14, 2021 · 2 comments

Comments

@cormullion
Copy link
Contributor

As I was looking for helpful information, I typed

help?> CSV.File

Screenshot 2021-04-14 at 08 38 57

I think this could be improved with some newlines in the docstring - easy to fix, but just checking that it's not autogenerated from somewhere else or formatted specially for Documenter...
@quinnj
Copy link
Member

quinnj commented Apr 14, 2021

Gross! A PR would definitely be welcome to fix that!

@cormullion
Copy link
Contributor Author

It's a bit better. I get confused with Markdown "standards"!

Screenshot 2021-04-14 at 17 44 08

@cormullion cormullion mentioned this issue Apr 14, 2021
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@cormullion @quinnj