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

Developer may explore the normalized event data-structure exposed by Compensated programmatically #51

Open
zspencer opened this issue Mar 27, 2020 · 0 comments
Labels
code Work that will require some amount of programming enhancement New feature or request
Milestone

Comments

@zspencer
Copy link
Member

zspencer commented Mar 27, 2020

At present, people have to either A) read the source or B) read the docs to understand what is available on an event normalized by Compensated. This adds significant cognitive overhead; and reduces adoption.

To mitigate that, we could sprout a Compensated::Event class and ensure that each of our adapters return an instance of it from their #normalize method; while ensuring it can be accessed using the standard event[:foo] syntax that our existing clients use.

This should include YARDoc for the data structures we're exposing on the event, so that tools like Solargraph and ctags can make reasonable suggestions for autocompletion.

This should not include changes to the underlying data structure, for now.

@zspencer zspencer added enhancement New feature or request code Work that will require some amount of programming labels Mar 27, 2020
@zspencer zspencer self-assigned this Mar 27, 2020
@zspencer zspencer removed their assignment Mar 27, 2020
@zspencer zspencer changed the title Create a Compensated::Event class that makes the core data structures explicit Developer may know what the data-structure being exposed by Compensated are programmatically Mar 27, 2020
@zspencer zspencer changed the title Developer may know what the data-structure being exposed by Compensated are programmatically Developer may explore the normalized event data-structure exposed by Compensated programmatically Mar 27, 2020
@zspencer zspencer added this to the 0.1.0 milestone Mar 28, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
code Work that will require some amount of programming enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant