docs: Create an example for a component

[prakrit55]

fixing #743

[prakrit55]

@niccokunzmann, we can have a discussion here.

[coveralls]

Pull Request Test Coverage Report for Build 12097205435

Details

• 0 of 0 changed or added relevant lines in 0 files are covered.
• No unchanged relevant lines lost coverage.
• Overall coverage remained the same at 96.355%

---

Totals
Change from base Build 12058486016:	0.0%
Covered Lines:	4580
Relevant Lines:	4747

---

💛 - Coveralls

[niccokunzmann]

This is the right place. Now, could you copy in an example from the rfc?

[prakrit55]

This is the right place. Now, could you copy in an example from the rfc?

is there any way to generate rfc files, could you mention any way to do this

[stevepiercy]

@prakrit55 RFC stands for Request for Comments. The issue to be resolved would be to copy an example from the specific RFC 5545 for one of the given components, and write a Python doctest for it in its method.

I'm not sure why the issue todo for each of the three checked add src/icalendar/tests/todos/example.ics is checked, because I don't see the todo folder in the repo where it says it should be.

@niccokunzmann perhaps you could update the issue description with some more details? I'm not clear myself.

[prakrit55]

@prakrit55 RFC stands for Request for Comments. The issue to be resolved would be to copy an example from the specific RFC 5545 for one of the given components, and write a Python doctest for it in its method.

I'm not sure why the issue todo for each of the three checked add src/icalendar/tests/todos/example.ics is checked, because I don't see the todo folder in the repo where it says it should be.

@niccokunzmann perhaps you could update the issue description with some more details? I'm not clear myself.

hello @stevepiercy, thanks for the reply, does the repo have any examples you can point me to

[niccokunzmann]

@prakrit55, could you have a look at the documentation and the file structure and the issue - the issue points towards

• what has been done already

I also added links at the bottom. It is a joint effort to make everything clear and I value you stepping forward to improve the project. The challenge for me here is to balance the time it takes to solve it myself with the time it takes on get you on board. So, a PR with one empty file is a small step and I would like you to get a bit familiar with the project by yourself. However, I can also understand that it is hard to get started at all. So, I will point you in some directions and help you when you get stuck. Please have a look at "what was done already" in the issue and give it your bravest, best shot in what you think should go into that file. https://www.rfc-editor.org/info/rfc5545 will help.

Then, please ask again.

@stevepiercy, I will write more into the issue now. It was a copy&paste mistake.