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

Create an example for a component (Python) #743

Open
9 of 28 tasks
niccokunzmann opened this issue Nov 11, 2024 · 0 comments
Open
9 of 28 tasks

Create an example for a component (Python) #743

niccokunzmann opened this issue Nov 11, 2024 · 0 comments
Labels
doc good first issue hacktoberfest Issues for participation in the hacktoberfest https://hacktoberfest.com/

Comments

@niccokunzmann
Copy link
Member

niccokunzmann commented Nov 11, 2024 •
edited
Loading

To enhance the documentation, it is nice to have examples!

  • Todo
    • add src/icalendar/tests/todos/exmaple.ics
    • add example() method with default
    • show how to use the example in the class docstring
    • test in src/icalendar/tests/test_examples.py
  • Journal
    • add src/icalendar/tests/journals/exmaple.ics
    • add example() method with default
    • show how to use the example in the class docstring
    • test in src/icalendar/tests/test_examples.py
  • FreeBusy
    • add src/icalendar/tests/freebusy/exmaple.ics
    • add example() method with default
    • show how to use the example in the class docstring
    • test in src/icalendar/tests/test_examples.py
  • Alarm
    • add src/icalendar/tests/alarms/exmaple.ics
    • add example() method with default
    • show how to use the example in the class docstring
    • test in src/icalendar/tests/test_examples.py
  • Event
    • add src/icalendar/tests/todos/exmaple.ics
    • add example() method with default
    • show how to use the example in the class docstring
    • test in src/icalendar/tests/test_examples.py
  • Calendar
    • add src/icalendar/tests/todos/exmaple.ics
    • add example() method with default
    • show how to use the example in the class docstring
    • test in src/icalendar/tests/test_examples.py
  • Timezone
    • add src/icalendar/tests/todos/exmaple.ics
    • add example() method with default
    • show how to use the example in the class docstring
    • test in src/icalendar/tests/test_examples.py

This is an issue for beginners.
Please open a Pull Request to let us know you are working on it or ask below if you need any help!
A pull request should address at least one item in the list above. No need to do all at once.
@niccokunzmann niccokunzmann added doc good first issue hacktoberfest Issues for participation in the hacktoberfest https://hacktoberfest.com/ labels Nov 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
doc good first issue hacktoberfest Issues for participation in the hacktoberfest https://hacktoberfest.com/
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@niccokunzmann