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

display file content of example #504

Merged
merged 1 commit into from
Dec 20, 2022
Merged

Conversation

abe-101
Copy link
Contributor

@abe-101 abe-101 commented Dec 19, 2022

I suggest it might be a nice idea to display the content of the file generated in the example

@jacadzaca
Copy link
Collaborator

Could you try to make the expected output be tested? This way the documentation wont become stale.

In order for the test in
https://github.com/collective/icalendar/blob/master/src/icalendar/tests/test_with_doctest.py
not to fail it was necessary to normilize the whitespace
@abe-101
Copy link
Contributor Author

abe-101 commented Dec 20, 2022

Could you try to make the expected output be tested? This way the documentation wont become stale.

Done.
doctest are new to me but I think it should be good now

@jacadzaca jacadzaca merged commit 62a0edf into collective:master Dec 20, 2022
@jacadzaca
Copy link
Collaborator

Thanks!

@jacadzaca
Copy link
Collaborator

Personally, I'd make the commit message more detailed, e.g. show generated example's content on the usage page, but it's a nitpick.

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.

None yet

2 participants