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

[RFC 50] add member docstrings #2543

Merged
merged 4 commits into from Feb 28, 2018
Merged

[RFC 50] add member docstrings #2543

merged 4 commits into from Feb 28, 2018

Conversation

mfelsche
Copy link
Contributor

@mfelsche mfelsche commented Feb 8, 2018

This PR implements the first part of RFC 50: https://github.com/ponylang/rfcs/blob/master/text/0050-class-actor-fields-docstrings.md (The second part is docgen documentation in the tutorial).

It does roughly the following

  • adapting the parser to accept optional docstrings below actor and class fields
  • adapt the docgen pass to also display field docstrings if available

The ponylang mkdocs theme has been updated for field docstrings. Example:

field docstrings in pony docs with new theme

fixes #2502

it was failing during check_tree due to a missing optional STRING node for the docstring
and display fields more prominently
@mfelsche mfelsche added project documentation changelog - added Automatically add "Added" CHANGELOG entry on merge labels Feb 8, 2018
Copy link
Member

@jemc jemc left a comment

Choose a reason for hiding this comment

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

This looks good to me, but I'm not merging at this time because a review was requested from Sean.

@jemc jemc removed the request for review from SeanTAllen February 28, 2018 21:00
@mfelsche mfelsche merged commit 9171444 into master Feb 28, 2018
@mfelsche mfelsche deleted the rfc-50-member-docstrings branch February 28, 2018 21:00
ponylang-main added a commit that referenced this pull request Feb 28, 2018
@SeanTAllen
Copy link
Member

This is awesome!

dipinhora pushed a commit to dipinhora/ponyc that referenced this pull request Jun 5, 2018
* adapt parser to accept field docstrings

* fix desugaring of lambda captures as fields

it was failing during check_tree due to a missing optional STRING node for the docstring

* docgen: add docstring to fields docs

and display fields more prominently

* update pony.g for field docstrings
dipinhora pushed a commit to dipinhora/ponyc that referenced this pull request Jun 5, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
changelog - added Automatically add "Added" CHANGELOG entry on merge
Projects
None yet
Development

Successfully merging this pull request may close these issues.

RFC: class and actor field docstrings
3 participants