-
Notifications
You must be signed in to change notification settings - Fork 1.5k
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
Better formatting of docstring #919
Conversation
I think it's just a workaround because at present the APIs are limited (rendering the text as Markdown).
|
Looks good. But in my opinion, it will be fine to make headers much smaller, because white color already telling us tgat this is a header (like Examples, Returns, References) |
@neilsustc Thanks for your work on this. Let me know when you are ready for me to merge something. |
How about you get things working to a certain stage and we merge it. |
I think the docs will look good in most cases now, especially for But there are some conflicts and failed tests, @DonJayamanne can you help fix them? @1st I have set the headings to level 2 so they would become a bit smaller now. |
@DonJayamanne All done! |
Brilliant |
@neilsustc , there are some conflicts in jediHelper.ts, please could you resolve them. |
👌 |
Will be happy to test this new thing |
'Translate' reStructuredText into Markdown. Fix #821.
Screenshots