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.

Sign up for GitHub

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

Jump to bottom

feature: Render mixed-in methods and constants with --embed-mixins #842

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

feature: Render mixed-in methods and constants with --embed-mixins #842

wants to merge 1 commit into from
+228 −2

Commits on Mar 15, 2024

  1. Embed mixed-in methods and constants with --embed-mixins 

    When `--embed-mixins` option is set:

- methods from an `extend`ed module are documented as singleton methods
- attrs from an `extend`ed module are documented as class attributes
- methods from an `include`ed module are documented as instance methods
- attrs from an `include`ed module are documented as instance attributes
- constants from an `include`ed module are documented

Sections are created when needed, and Darkfish's template annotates
each of these mixed-in CodeObjects. We also respect the mixin methods'
visibility.

This feature is inspired by Yard's option of the same name.
    @flavorjones @hsbt
    flavorjones authored and hsbt committed Mar 15, 2024
    Configuration menu
    Copy the full SHA
    9f2a9f2 View commit details
    Browse the repository at this point in the history