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

Update docs for custom attributes to add annotations #328

Open
robrap opened this issue Jul 24, 2023 · 0 comments
Open

Update docs for custom attributes to add annotations #328

robrap opened this issue Jul 24, 2023 · 0 comments
Labels
help wanted Ready to be picked up by anyone in the community

Comments

@robrap
Copy link
Contributor

robrap commented Jul 24, 2023

Use of custom attributes is documented here:
https://edx.readthedocs.io/projects/edx-django-utils/en/latest/monitoring/how_tos/using_custom_attributes.html

We've been annotating custom attributes as seen in these examples:
https://github.com/search?q=(org%3Aedx%20OR%20org%3Aopenedx)%20custom_attribute_name&type=codev

    # .. custom_attribute_name: jwt_auth_check_symmetric_key
    # .. custom_attribute_description: True if symmetric keys will also be used for checking
    #   the JWT signature, and False if only asymmetric keys will be used.
    set_custom_attribute('jwt_auth_check_symmetric_key', decode_symmetric_token)
  1. The docs should detail this so we can more easily point people to this.
  2. As part of this or a separate issue, we should add Sphinx documentation for these annotations like was done for toggles and settings in https://github.com/openedx/code-annotations/tree/master/code_annotations/contrib/sphinx/extensions
@robrap robrap added the help wanted Ready to be picked up by anyone in the community label Jul 24, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Ready to be picked up by anyone in the community
Projects
None yet
Development

No branches or pull requests

1 participant