docs: add __all__ variables to some modules

[c0d33ngr]

This PR contributes to #638

---

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

[niccokunzmann]

@devdanzin could you have a look? If you see anything you would like to improve, please create a pull request to this one or suggest edits (I do not know how to do the last one) It could also be merged and another one created...

@c0d33ngr The tests are failing but I think that this is not your fault. I reported an issue: #677 Thanks for contributing so we can catch that problem with out CI setup!

dateutil is a module and should not be in __all__

Could you create a changelog entry for the next release?

[devdanzin]

@devdanzin could you have a look? If you see anything you would like to improve, please create a pull request to this one or suggest edits (I do not know how to do the last one)

Sure, I'll check the names against imports and any comments regarding whether they are public. I've suggest an edit to remove dateutil, I think @c0d33ngr only has to accept the suggested changes and they will be automatically merged.

[devdanzin]

Not from this PR, but in __init__.py there seems to be a typo ("vTypesFactory" -> "TypesFactory"):

icalendar/src/icalendar/__init__.py

Line 52 in 7fb1567

'vTypesFactory', 'Parameters', 'q_split', 'q_join', 'use_pytz', 'use_zoneinfo']

get_example() seems to be missing from __all__ in cal.py, is it part of the public interface?

ICAL_TYPE seems to be missing from __all__ in parser_tools.py.

@c0d33ngr, would you like me to add __all__ to prop.py?

[c0d33ngr]

Not from this PR, but in __init__.py there seems to be a typo ("vTypesFactory" -> "TypesFactory"):

icalendar/src/icalendar/__init__.py

Line 52 in 7fb1567

'vTypesFactory', 'Parameters', 'q_split', 'q_join', 'use_pytz', 'use_zoneinfo']

get_example() seems to be missing from __all__ in cal.py, is it part of the public interface?

ICAL_TYPE seems to be missing from __all__ in parser_tools.py.

@c0d33ngr, would you like me to add __all__ to prop.py?

Yeah... Please do for the prop.py

[niccokunzmann]

@c0d33ngr and @devdanzin Thanks for collaborating on this PR. We are watching the test runs because I reported that they fail and I do not know what to do: coverallsapp/github-action#217

So, thanks for working as contributors so that people in the future do not get broken test results.

[coveralls]

Pull Request Test Coverage Report for Build 9856530008

Details

• 9 of 9 (100.0%) changed or added relevant lines in 9 files are covered.
• No unchanged relevant lines lost coverage.
• Overall coverage increased (+0.006%) to 97.373%

---

Totals
Change from base Build 9793621435:	0.006%
Covered Lines:	3151
Relevant Lines:	3236

---

💛 - Coveralls

[devdanzin]

@c0d33ngr and @devdanzin Thanks for collaborating on this PR. We are watching the test runs because I reported that they fail and I do not know what to do: coverallsapp/github-action#217

If you'd like me to push dummy commits (in a new PR, I guess) so coveralls runs and you can get more data points, let me know.

[niccokunzmann]

Thanks for the help. I think, any work you do together here will create a new commit and then, we know more. There is no urgency and you do not have to consider that in a special way. I just wanted to let you know :) If you like to take up another issue though, we might find that other commits you make might show the same symptoms ;)

[c0d33ngr]

@devdanzin could you have a look? If you see anything you would like to improve, please create a pull request to this one or suggest edits (I do not know how to do the last one)

Sure, I'll check the names against imports and any comments regarding whether they are public. I've suggest an edit to remove dateutil, I think @c0d33ngr only has to accept the suggested changes and they will be automatically merged.

Thank you for the code review you did and also taking up the prop.py file 😊

[devdanzin]

Thank you for being so receptive!

Unfortunately I cannot push to this PR, so I've created a PR against it: c0d33ngr#1.

The same changes that go into that one go to #693 to see if I can trigger coveralls failures, but no luck so far :(

[c0d33ngr]

Thank you for being so receptive!

Unfortunately I cannot push to this PR, so I've created a PR against it: c0d33ngr#1.

The same changes that go into that one go to #693 to see if I can trigger coveralls failures, but no luck so far :(

Oh.. Okay. What can I do to assist?

[niccokunzmann]

@c0d33ngr, have a look here: c0d33ngr#1 there are some proposed changes.

[c0d33ngr]

@c0d33ngr, have a look here: c0d33ngr#1 there are some proposed changes.

I merged @devdanzin branch into mine

[niccokunzmann]

Thanks!