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.

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

The "Simple Example" of the documentation is not working #33

Closed
develop-cs opened this issue Aug 14, 2024 · 0 comments · Fixed by #34
Closed

The "Simple Example" of the documentation is not working #33

develop-cs opened this issue Aug 14, 2024 · 0 comments · Fixed by #34
Labels
bug Something isn't working documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@develop-cs
Copy link
Collaborator

Describe the bug:

There is some wrong informations in the Simple Example documentation section:

image

The example is not working as it should.

Expected behavior:

  1. Change value to course_id in rules.yaml.
  2. Change bool type hint to str | None in actions.py.
@develop-cs develop-cs added bug Something isn't working documentation Improvements or additions to documentation good first issue Good for newcomers labels Aug 14, 2024
develop-cs added a commit that referenced this issue Sep 5, 2024
@develop-cs
docs: fix simple example (#33)
e81ae6f 
Signed-off-by: develop-cs <43383361+develop-cs@users.noreply.github.com>
@develop-cs develop-cs mentioned this issue Sep 5, 2024
Merged
3 tasks
develop-cs added a commit that referenced this issue Sep 5, 2024
@develop-cs
Feature/doc_fix (#34)
b7b8938 
* docs: fix simple example (#33)

Signed-off-by: develop-cs <43383361+develop-cs@users.noreply.github.com>

* docs: update changelog

Signed-off-by: develop-cs <43383361+develop-cs@users.noreply.github.com>

---------

Signed-off-by: develop-cs <43383361+develop-cs@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
bug Something isn't working documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Feature/doc_fix MAIF/arta
1 participant
@develop-cs