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

merge file structure with overview section #739

Merged
merged 10 commits into from
Nov 21, 2024

Conversation

natashamm
Copy link
Contributor

@natashamm natashamm commented Oct 31, 2024

From #626

I didn't change much of the content for now.


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

@coveralls
Copy link

coveralls commented Oct 31, 2024

Pull Request Test Coverage Report for Build 11937030576

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.

Details

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • 38 unchanged lines in 6 files lost coverage.
  • Overall coverage increased (+0.2%) to 97.708%

Files with Coverage Reduction New Missed Lines %
src/icalendar/timezone/init.py 1 85.71%
src/icalendar/tests/test_issue_662_component_properties.py 4 97.78%
src/icalendar/timezone/tzp.py 5 93.24%
src/icalendar/tests/conftest.py 5 95.63%
src/icalendar/cal.py 11 98.46%
src/icalendar/prop.py 12 97.88%
Totals Coverage Status
Change from base Build 11763222108: 0.2%
Covered Lines: 4130
Relevant Lines: 4224

💛 - Coveralls

Copy link
Member

@stevepiercy stevepiercy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some syntax improvements, grammar fixes. Please spell out words, as it makes it easier to translate them.

docs/usage.rst Outdated Show resolved Hide resolved
docs/usage.rst Outdated Show resolved Hide resolved
docs/usage.rst Outdated Show resolved Hide resolved
docs/usage.rst Outdated Show resolved Hide resolved
docs/usage.rst Outdated Show resolved Hide resolved
docs/usage.rst Outdated Show resolved Hide resolved
docs/usage.rst Outdated Show resolved Hide resolved
docs/usage.rst Outdated Show resolved Hide resolved
docs/usage.rst Show resolved Hide resolved
docs/usage.rst Outdated Show resolved Hide resolved
@natashamm natashamm force-pushed the file_stucture_overview branch from 2aaf054 to 8a4923a Compare November 4, 2024 16:33
natashamm and others added 2 commits November 4, 2024 08:35
Co-authored-by: Steve Piercy <[email protected]>
Co-authored-by: Steve Piercy <[email protected]>
@niccokunzmann
Copy link
Member

I think, the docs pass the build. @natashamm , could you add a changelog entry? Let me know when you are done improving the docs! Thanks :)

@niccokunzmann
Copy link
Member

Also, you can look here to see if it is how you like it: https://icalendar--739.org.readthedocs.build/en/739/usage.html

natashamm and others added 4 commits November 19, 2024 18:03
@natashamm
Copy link
Contributor Author

@niccokunzmann it is ready to go if the line wrapping conversation can be resolved!

Copy link
Member

@stevepiercy stevepiercy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I cleaned up all the code blocks to use the correct lexer, whether it was pycon or text according to its context.

@niccokunzmann niccokunzmann merged commit 5732b8f into collective:main Nov 21, 2024
18 checks passed
@niccokunzmann
Copy link
Member

Thanks @natashamm and @stevepiercy!

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.

4 participants