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

allow wrapped lines in "see also" numpy section #141

Merged
merged 2 commits into from
Jan 12, 2020
Merged

allow wrapped lines in "see also" numpy section #141

merged 2 commits into from
Jan 12, 2020

Conversation

poke1024
Copy link
Contributor

This is to allow multiline comments in numpy "See Also" sections.

Here's an example from the wild from seaborn:
https://github.com/mwaskom/seaborn/blob/66191d8a179f1bfa42f03749bc4a07e1c0c08156/seaborn/axisgrid.py#L2204

Currently, pdoc renders this as:

old

With this PR, this is rendered as:

new

kernc
kernc requested changes Dec 24, 2019
View reviewed changes
Copy link
Member

@kernc kernc left a comment

Choose a reason for hiding this comment

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

Definitely needs a test case in the appropriate section of pdoc.test.example_pkg.Docformats.numpy().

pdoc/html_helpers.py Outdated Show resolved Hide resolved
@kernc kernc added the bug Something isn't working label Dec 24, 2019
@kernc
Copy link
Member

kernc commented Jan 11, 2020

Now that new year is over, care to finish this? 😃

@poke1024
Copy link
Contributor Author

poke1024 commented Jan 11, 2020 •
edited

So far so good:

example

@kernc
Copy link
Member

kernc commented Jan 12, 2020

Applied with slight modification. Thanks!

@kernc kernc merged commit 30ca5ef into pdoc3:master Jan 12, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@kernc kernc kernc approved these changes

Assignees
No one assigned
Labels
bug Something isn't working
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@poke1024 @kernc