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

Fixed heading in markdown doc #258

Merged
merged 2 commits into from
Oct 4, 2017
Merged

Conversation

marcusoftnet
Copy link

Hi,

Read the documentation and saw that the configuration part of the first doc string is not rendered correctly.

There's a missing newline/empty line before the heading Configuration.

Hi, 

Read the documentation and saw that the configuration part of the first doc string is not rendered correctly. 

There's a missing newline/empty line before the heading Configuration.
@coveralls
Copy link

Coverage Status

Coverage remained the same at 79.747% when pulling d1df117 on marcusoftnet:patch-1 into ccf54d0 on code-corps:master.

1 similar comment
@coveralls
Copy link

Coverage Status

Coverage remained the same at 79.747% when pulling d1df117 on marcusoftnet:patch-1 into ccf54d0 on code-corps:master.

Apparently, the heading (`#`) construct doesn't work in `@moduledoc`.

Made a poor-mans-heading instead. Commit if you want to
@coveralls
Copy link

coveralls commented Oct 2, 2017

Coverage Status

Coverage remained the same at 79.747% when pulling c036c06 on marcusoftnet:patch-1 into ccf54d0 on code-corps:master.

### Configuring

**Configuring**

Copy link
Contributor

Choose a reason for hiding this comment

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

This replaces an <h3> in the generated output with a <strong> tag.

Ideally, it should be enough of a fix to simply keep the ### Configuring and and a new line before AND after it.

Did you try that and it did not work?

@marcusoftnet
Copy link
Author

Hi,

yes, I tried that and for some reason, that formatting doesn't work in the moduledoc attribute but does work in a doc section.

I'm not happy with this but it's at least better than the output today that contains the ### or, if you add blank lines, drops the configuration-documentation altogether.

If you want to drop this PR I totally understand. Just saw it in the docs and thought I'd try to fix it.

@begedin
Copy link
Contributor

begedin commented Oct 4, 2017

@marcusoftnet Seems you're right. I even tried updating ex_doc but it didn't help.

Oh well, it might not be an actual header, but it looks like one, compared to what it previously looked like, so I'd say this is good to go.

@begedin begedin merged commit df7d407 into beam-community:master Oct 4, 2017
@begedin
Copy link
Contributor

begedin commented Oct 4, 2017

Thank you @marcusoftnet 👍

@marcusoftnet
Copy link
Author

Awesome! That's how i thought about it too!

Thanks a lot

@marcusoftnet marcusoftnet deleted the patch-1 branch October 4, 2017 08:09
@mjadczak
Copy link
Contributor

mjadczak commented Oct 4, 2017

Should we perhaps try to find when the issue happens exactly and submit an issue to ex_doc?

@marcusoftnet
Copy link
Author

Oh, lovely - I think I could do that. Is that a separate repo?

@begedin
Copy link
Contributor

begedin commented Oct 4, 2017

ex_doc is the package providing the mix doc command

How I would go about this

  1. Create a tracking issue here
  2. Create an issue on https://github.com/elixir-lang/ex_doc explaining as much as possible about what the problem is.
  3. Link the external issue to our tracking issue

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.

4 participants