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

Improve code annotations and integrate with docs #166

Open
1 of 2 tasks
mariajgrimaldi opened this issue May 1, 2024 · 1 comment
Open
1 of 2 tasks

Improve code annotations and integrate with docs #166

mariajgrimaldi opened this issue May 1, 2024 · 1 comment
Labels
documentation Relates to documentation improvements

Comments

@mariajgrimaldi
Copy link
Member

mariajgrimaldi commented May 1, 2024

We should have a way of automatically generating documentation for each filter, just as it happens with openedx-events: openedx/openedx-events#316
Also, in-line docs for each class should be improved. Another thing we should do is to make available the different versions on the docs page

Tasks

  1. open-source-contribution
@mariajgrimaldi
Copy link
Member Author

I removed the link so this issue doesn't when merging the first task.

@mariajgrimaldi mariajgrimaldi added maintenance Routine upkeep necessary for the health of the platform documentation Relates to documentation improvements and removed maintenance Routine upkeep necessary for the health of the platform labels Jun 24, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Relates to documentation improvements
Projects
None yet
Development

No branches or pull requests

1 participant