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

Better formatting of docstring #919

Merged
merged 8 commits into from
May 5, 2017
Merged

Better formatting of docstring #919

merged 8 commits into from
May 5, 2017

Conversation

yzhang-gh
Copy link
Contributor

@yzhang-gh yzhang-gh commented Apr 27, 2017

'Translate' reStructuredText into Markdown. Fix #821.

Screenshots

1

2

3

4

@yzhang-gh
Copy link
Contributor Author

yzhang-gh commented Apr 29, 2017

I think it's just a workaround because at present the APIs are limited (rendering the text as Markdown).

  • Setext headings -> ATX headings (## Section Title)
  • Directives: .. directive:: -> **directive**
  • Field lists: :field: -> **field**
  • varname : description -> `varname` description
  • Doctest blocks: begin with >>> and end with blank line -> Markdown code blocks
  • Literal blocks: begin with :: (literal blocks are indented or quoted; for simplicity, we end literal blocks with blank line)
  • Remove indention in Field lists and Literal blocks
  • Grid tables

@1st
Copy link

1st commented May 4, 2017

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)

@DonJayamanne
Copy link
Owner

@neilsustc Thanks for your work on this. Let me know when you are ready for me to merge something.

@DonJayamanne
Copy link
Owner

How about you get things working to a certain stage and we merge it.
I.e. merge incrementally...

@yzhang-gh
Copy link
Contributor Author

I think the docs will look good in most cases now, especially for numpy and sklearn.

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.

@yzhang-gh
Copy link
Contributor Author

@DonJayamanne All done!

@DonJayamanne
Copy link
Owner

DonJayamanne commented May 5, 2017

Brilliant risk work mate, will check this out tonight and release something soon.

@DonJayamanne
Copy link
Owner

@neilsustc , there are some conflicts in jediHelper.ts, please could you resolve them.

@yzhang-gh
Copy link
Contributor Author

👌

@DonJayamanne DonJayamanne merged commit d21e64f into DonJayamanne:master May 5, 2017
@1st
Copy link

1st commented May 5, 2017

Will be happy to test this new thing

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