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

Highlight indented method signatures in docstrings by default #980

Merged
merged 4 commits into from
Mar 12, 2019
Merged

Highlight indented method signatures in docstrings by default #980

merged 4 commits into from
Mar 12, 2019

Conversation

christopher-dG
Copy link
Contributor

Here's my attempt at closing #978.

When highlightsig is not set to false in makedocs, leading, unlabeled code blocks in docstrings (i.e. the usual indented signature) are labeled as Julia.

Open to any bikeshedding 😅

@mortenpi mortenpi added this to the 0.22.0 milestone Mar 10, 2019
@mortenpi
Copy link
Member

Implementation LGTM! Could use a (1) entry in the makedocs docstring, (2) a CHANGELOG entry, and (3) perhaps a few simple tests for highlightsig!, e.g. that the following ones get transformed correctly:

    foo
---
    bar
```xyz
foo
```

@christopher-dG
Copy link
Contributor Author

christopher-dG commented Mar 12, 2019

Ok, I have done those things. I put the tests in runtests.jl since I didn't find any other file relevant to Expanders. And any idea why the changelog doesn't seem to want to render the link to this PR? I may be somewhat overtired but the raw text looks identical to the other links...

@mortenpi
Copy link
Member

I put the tests in runtests.jl since I didn't find any other file relevant to Expanders.

That's fine.

And any idea why the changelog doesn't seem to want to render the link to this PR?

It needs the URL down at the bottom of the file.

@christopher-dG
Copy link
Contributor Author

Oh cool, thanks. I'll take care of that first thing in the morning.

@christopher-dG
Copy link
Contributor Author

Ok, fixed now.

@mortenpi
Copy link
Member

Lovely, thank you!

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

Successfully merging this pull request may close these issues.

2 participants