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

strip trailing whitespace in generated docstrings #366

Merged
merged 3 commits into from
Jan 3, 2022

Conversation

visr
Copy link
Contributor

@visr visr commented Jan 2, 2022

And also remove remove empty lines in Parameters or Returns lists. Though it could be that I don't understand the reason those need to be there. The markdown format doesn't require them.

@melonedo
Copy link
Contributor

melonedo commented Jan 3, 2022

From Julia manual on markdown lists, the empty line is required for complex markdown elements. For example a nested list in parameter.

## Parameters
- `arg`: This arguments takes various forms:
    - form1
    - form2
- `arg2`: code block

    ```c
    int foo(void);
    ````

My experiments showed no difference though.

@Gnimuc
Copy link
Member

Gnimuc commented Jan 3, 2022

That doc is probably outdated. This change might be related.

@melonedo
Copy link
Contributor

melonedo commented Jan 3, 2022

So we can omit the empty line as long as we do not find broken format. I could not reproduce what formatting issue might be triggered by omitting that.

@Gnimuc Gnimuc merged commit 331313d into JuliaInterop:master Jan 3, 2022
@visr visr deleted the docs-whitespace branch January 3, 2022 06:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants