Skip to content

Doc with markdown header is not formatted correctly #52

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

Closed
sethladd opened this issue Jan 7, 2015 · 4 comments
Closed

Doc with markdown header is not formatted correctly #52

sethladd opened this issue Jan 7, 2015 · 4 comments
Assignees
Labels
P1 A high priority bug; for example, a single project is unusable or has many test failures type-bug Incorrect behavior (everything from a crash to more subtle misbehavior)

Comments

@sethladd
Copy link
Contributor

sethladd commented Jan 7, 2015

See this file: https://github.com/localvoid/timezone/blob/master/lib/timezone.dart

Specifically:

/// # TimeZone library
///
/// Time zone database and time zone aware DateTime.
library timezone;

It's rendered as:

screen shot 2015-01-06 at 4 33 54 pm

Expected:

The word TimeZone should be a header (H1?)

@sethladd sethladd added type-bug Incorrect behavior (everything from a crash to more subtle misbehavior) P1 A high priority bug; for example, a single project is unusable or has many test failures labels Jan 7, 2015
@sethladd
Copy link
Contributor Author

sethladd commented Jan 7, 2015

The Dart language spec used to have a subset of markdown for what you can use inside of doc comments. The latest version of the spec (second edition) no longer specifies what goes into doc comments.

There's probably enough doc comments that use markdown that we need to support it.

@sethladd
Copy link
Contributor Author

sethladd commented Jan 7, 2015

This is what the previous dartdoc used: https://pub.dartlang.org/packages/markdown

@sethladd
Copy link
Contributor Author

sethladd commented Jan 8, 2015

The cleanupDocs method does some markdown formatting, but misses headers.

@sethladd
Copy link
Contributor Author

sethladd commented Feb 1, 2015

This should be fixed.

@sethladd sethladd closed this as completed Feb 1, 2015
@sethladd sethladd assigned sethladd and unassigned keertip Feb 1, 2015
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
P1 A high priority bug; for example, a single project is unusable or has many test failures type-bug Incorrect behavior (everything from a crash to more subtle misbehavior)
Projects
None yet
Development

No branches or pull requests

2 participants