Skip to content

doc: full API#207

Open
ivanoblomov wants to merge 10 commits intomasterfrom
document-dynamic-attributes
Open

doc: full API#207
ivanoblomov wants to merge 10 commits intomasterfrom
document-dynamic-attributes

Conversation

@ivanoblomov
Copy link
Copy Markdown
Collaborator

@ivanoblomov ivanoblomov commented Nov 3, 2025

Closes: #201

Goal

Document the full API including attributes and aliases.

Approach

  1. Force RDoc to document metaprogrammed attribute-readers with:
      # :attr_reader: city
  2. Add @return types to aliases to satisfy inch --pedantic.
  3. Add @return, @example to #coordinates.
  4. Describe attribute and their aliases consistently.
  5. Move variable types before names for consistency.
  6. (Fully qualify require path in README.)

Signed-off-by: Roderick Monje rod@foveacentral.com

@ivanoblomov ivanoblomov added the documentation Improvements or additions to documentation label Nov 3, 2025
@ivanoblomov ivanoblomov changed the title Document dynamic attributes doc: dynamic attributes Nov 3, 2025
@ivanoblomov ivanoblomov changed the title doc: dynamic attributes doc: full API Nov 12, 2025
@ivanoblomov
Copy link
Copy Markdown
Collaborator Author

@olleolleolle any way you can review this and #145 when you get a chance?

Thanks in advance!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Document full API

1 participant