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.

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

Enhance documentation of API #637

Merged
merged 5 commits into from
Jun 21, 2024
Merged

Enhance documentation of API #637

merged 5 commits into from
Jun 21, 2024

Conversation

stevepiercy
Copy link
Member

@stevepiercy stevepiercy commented Jun 21, 2024

Fixes #631.

Depends on #636 for change log consistency.

I also fixed a docstring that returned this error:

/Users/stevepiercy/projects/icalendar/src/icalendar/prop.py:docstring of icalendar.prop:4: CRITICAL: Missing matching underline for section title overline.

###########################################################################
# This module defines these property value data types and property parameters

Sphinx treated that line as a page title, and a blank line resolved the issue.

I'm not sure whether you want that line to be a comment or displayed, though.

@coveralls
Copy link

coveralls commented Jun 21, 2024

Pull Request Test Coverage Report for Build 9606426632

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 97.228%

Totals Coverage Status
Change from base Build 9598258374: 0.0%
Covered Lines: 3087
Relevant Lines: 3175

💛 - Coveralls

@coveralls
Copy link

coveralls commented Jun 21, 2024

Pull Request Test Coverage Report for Build 9606439009

Details

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

Files with Coverage Reduction New Missed Lines %
src/icalendar/timezone/zoneinfo.py 2 94.67%
src/icalendar/tests/test_cli_tool.py 2 88.0%
Totals Coverage Status
Change from base Build 9598258374: 0.0%
Covered Lines: 3087
Relevant Lines: 3175

💛 - Coveralls

@niccokunzmann niccokunzmann merged commit 675102d into main Jun 21, 2024
13 checks passed
@niccokunzmann niccokunzmann deleted the 631-docs-enhance-api branch June 21, 2024 17:04
@niccokunzmann
Copy link
Member

Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Documentation does not show all objects available
3 participants