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

Make introspection XML better diffable for docs #131

Closed
wants to merge 1 commit into from

Conversation

mvidner
Copy link
Owner

@mvidner mvidner commented Apr 4, 2023

(This is useful for agama-project/agama#415)

That is, make separate closing tags, so that our output can be easier edited (and diffed line by line) to add XML documentation.

This is a small performance penalty for clients that do runtime introspection.
To avoid introspection, call ProxyObjectInterface#define_method, see examples/no-introspect/tracker-test.rb
(TODO: make it easier, all the way from the top)

That is, make separate closing tags, so that our output can be easier
edited (and diffed line by line) to add XML documentation.

This is a small performance penalty for clients that do runtime
introspection.
To avoid introspection, call ProxyObjectInterface#define_method, see
examples/no-introspect/tracker-test.rb
(TODO: make it easier, all the way from the top)
@coveralls
Copy link

Coverage Status

Coverage: 95.324%. Remained the same when pulling 015517b on diffable-introspection into dae55db on master.

@mvidner
Copy link
Owner Author

mvidner commented Apr 8, 2023

In the end this is not needed, we perform more complex diffing anyway

@mvidner mvidner closed this Apr 8, 2023
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.

2 participants