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

fix apidoc bad format #1245

Merged
merged 2 commits into from
Jan 14, 2019
Merged

fix apidoc bad format #1245

merged 2 commits into from
Jan 14, 2019

Conversation

AdrianRaFo
Copy link
Contributor

Fix bad format due to markdown list on table style

Fixes #1228

@calvellido calvellido self-requested a review January 14, 2019 15:13
@calvellido
Copy link
Member

I don't think this fixes #1228 as a whole, does it?

Copy link
Member

@calvellido calvellido left a comment

Choose a reason for hiding this comment

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

👍

@AdrianRaFo
Copy link
Contributor Author

I tested locally it does

@calvellido
Copy link
Member

I was under the assumption that #1228 was caused by a bad formatting generated by Dokka, @israelperezglez could you please clarify?

@AdrianRaFo
Copy link
Contributor Author

AdrianRaFo commented Jan 14, 2019

that could make sense if all the file was a bad format but only one section has it. Also, I found really weird the return lists only in that section so after delete the * which gives the bad list format it was fixed

@JorgeCastilloPrz
Copy link
Member

JorgeCastilloPrz commented Jan 14, 2019

This is welcome but I think it does not fix the issue. The issue is about wrongly rendered tables in the autogenerated sections of the doc. @israelperezglez was working on that.

More context:

captura de pantalla 2019-01-14 a las 17 22 29

Could you please add a screenshot on how it looks like after your changes just in case @AdrianRaFo ?

@AdrianRaFo
Copy link
Contributor Author

screenshot from 2019-01-14 18 26 26

Copy link
Member

@JorgeCastilloPrz JorgeCastilloPrz left a comment

Choose a reason for hiding this comment

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

Alright looks good to me. I was wrong, this fixes it. Thanks!

@AdrianRaFo AdrianRaFo merged commit e82fcf6 into master Jan 14, 2019
@AdrianRaFo AdrianRaFo deleted the arf-fix-apidoc-bad-format branch January 14, 2019 18:52
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.

3 participants