Document vRecur property

[fluxxcode]

This PR adds an example to the usage documentation on how to add an RRULE from a string.

Closes #758

---

📚 Documentation preview 📚: https://icalendar--759.org.readthedocs.build/

[niccokunzmann]

Hi, this is nice... I wonder why it fails. I will have a look.

In the mean time, could you also add these examples to the vRecur class documentation?

[niccokunzmann]

Oh, I found it... We actually run the documentation code to make sure it works.
You add another RRULE entry and that makes the output different a few lines further down.

I think, a good place to add the documentation for this is actually the class string:

icalendar/src/icalendar/prop.py

Line 1102 in 4725c1b

"""Recurrence definition.

There is almost nothing and more is appreciated! Could you add these two examples to the class string? Could you remove this line causing duplicate entry?

---

This is another issue to make this class nicer to understand:
#742
That is - if you like this class and making it pretty ❤️

[fluxxcode]

Done. I copied most of the docstring from the rfc. Let me know if you want me to adjust anything.

[niccokunzmann]

@fluxxcode Have a look, can you see the tests?

https://github.com/collective/icalendar/actions/runs/12449350281/job/34754863315#step:5:192

(I am not sure who Github allows to see them)

[niccokunzmann]

Nice!

[fluxxcode]

My code editor removed trailing whitespaces from other docstrings. Let me know if I should revert the diffs

[stevepiercy]

Direct links to preview changes:

• https://icalendar--759.org.readthedocs.build/en/759/usage.html#example
• https://icalendar--759.org.readthedocs.build/en/759/api.html#icalendar.prop.vRecur None of the attributes are correctly formatted, except for Example because it is on its own line whereas the others are not. Can you adjust the other parameters to match the whitespace layout?

[stevepiercy]

All parameter names must appear on their own line, followed by an optional description beginning on an indented new line. Please adjust the others accordingly. Except is OK. See current rendering at https://icalendar--759.org.readthedocs.build/en/759/api.html#icalendar.prop.vRecur

Suggested change

	Property Name: RRULE
	Property Name:
	RRULE

[fluxxcode]

The rendering now looks good

[coveralls]

Pull Request Test Coverage Report for Build 12449529289

Warning: This coverage report may be inaccurate.

This pull request's base commit is no longer the HEAD commit of its target branch. This means it includes changes from outside the original pull request, including, potentially, unrelated coverage changes.

• For more information on this, see Tracking coverage changes with pull request builds.
• To avoid this issue with future PRs, see these Recommended CI Configurations.
• For a quick fix, rebase this PR at GitHub. Your next report should be accurate.

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.372%

---

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

---

💛 - Coveralls

[niccokunzmann]

Thanks! This is definitely a huge improvement!