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

Improve the docstring of abstract.CloudEvent #247

Open

ncouture opened this issue Dec 22, 2024 · 0 comments

ncouture commented Dec 22, 2024 •

edited

Loading

The getitem of this class goes on to describe that:

sdk-python/cloudevents/abstract/event.py

Lines 99 to 100 in c5645d8

    
                   The `data` of the event should be accessed by the `.data` accessor rather 
        
                   than this mapping.

providing a reason and perhaps a reference to an example would help developers understand why event.get() is discouraged by this helper method.

For instance, there is confusion in how the private _attributes data should be accessed expressed in #246.

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