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

Clearly document what properties message schema classes should override #166

Closed
jeremycline opened this issue Apr 24, 2019 · 1 comment · Fixed by #168

Comments

@jeremycline
Copy link
Member

commented Apr 24, 2019

At the moment, it's not clear from the message API docs (https://fedora-messaging.readthedocs.io/en/stable/api.html#fedora_messaging.message.Message) that users are expected to override and provide certain properties so that filtering can be applied for things like notifications.

We should add notes to the properties users should override.

@AdamWill

This comment has been minimized.

Copy link
Contributor

commented Apr 24, 2019

Also point to this from somewhere around https://fedora-messaging.readthedocs.io/en/stable/messages.html#schema , ideally.

jeremycline added a commit to jeremycline/fedora-messaging that referenced this issue Apr 25, 2019
Improve the readability of the API documentation
This expands the message API documentation and adds a table of content
to the top of the API docs, separating each function or class with a
sub-header. It should provide a high level overview of the complete API
at a glance, and fleshes out some of the API documentation that was
lacking in the Message class.

Fixes: fedora-infra#164
Fixes: fedora-infra#166

Signed-off-by: Jeremy Cline <jcline@redhat.com>
jeremycline added a commit to jeremycline/fedora-messaging that referenced this issue Apr 25, 2019
Improve the readability of the API documentation
This expands the message API documentation and adds a table of content
to the top of the API docs, separating each function or class with a
sub-header. It should provide a high level overview of the complete API
at a glance, and fleshes out some of the API documentation that was
lacking in the Message class.

Fixes: fedora-infra#164
Fixes: fedora-infra#166

Signed-off-by: Jeremy Cline <jcline@redhat.com>
jeremycline added a commit to jeremycline/fedora-messaging that referenced this issue May 21, 2019
Improve the readability of the API documentation
This expands the message API documentation and adds a table of content
to the top of the API docs, separating each function or class with a
sub-header. It should provide a high level overview of the complete API
at a glance, and fleshes out some of the API documentation that was
lacking in the Message class.

Fixes: fedora-infra#164
Fixes: fedora-infra#166

Signed-off-by: Jeremy Cline <jcline@redhat.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
2 participants
You can’t perform that action at this time.