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

Using --abstract completely overwrites the existing abstract for non-custom categories. #600

Closed
thibaudrobelain opened this issue Jun 27, 2016 · 2 comments

Comments

@thibaudrobelain
Copy link

The README states "Using the --abstract options, extra markdown can be included after the heading of section overview pages. Think of it as a template include."

Currently, it works fine if you're providing .md files for entirely new sections, but if you provide say "MyClass.md", it will overwrite the existing abstract for MyClass with the .md one instead of simply appending it at the end.

I'm assuming opening a PR to fix this doesn't change much because existing functionality for new sections isn't changed, it will just extend that functionality to auto-generated docs for classes, enums etc.
I'll open one in a bit!

@agentk
Copy link
Collaborator

agentk commented Jun 27, 2016

That's a good catch @thibaudrobelain, I had only ever thought of it as a fix for custom sections not having an abstract. I think appending the existing content should be the correct behaviour. I don't see much point in adding an option to choose between behaviours.

I would be interested to see what anybody else using the --abstract option has run into too.

@johnfairh
Copy link
Collaborator

This was fixed a while ago by PR starting with the one linked above.

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

No branches or pull requests

4 participants