collective / icalendar

98%

main: 98%

LAST BUILD ON BRANCH improve-docstrings

branch: improve-docstrings

CHANGE BRANCH

x

Reset

Sync Branches

• improve-docstrings
• 1004-code-conventions
• 1006-readme-reorg
• 1017-parser_tools-docstring
• 1031-contributors
• 1043-add-documentation-heading
• 1076-parameters-not-args
• 1079-document-init-methods
• 1080-docstring-new-rule
• 1095-tweak-doc-links
• 1102-uv-dev
• 1106-move-edit-page-link
• 1112-docs-cleanup
• 1129-typing-from-ical-method
• 1137-make-vale
• 1156-auto-type-hint-in-class
• 1161-explain-black-magic
• 1165-enhance-contrib-first-timer
• 1194-version-switcher
• 1214-enhance-docs-footer
• 1244-attry.categories_property-docstring
• 1245-docstrings-followup
• 1292-reorg-design-docs
• 4.x
• 487-regression-dddtype-not-hashable-in-icalendar-5
• 6.0.0a0-release-date-fix
• 6.x
• 631-docs-enhance-api
• 635-docs-build-on-py12
• 673-docs-sphinx-autobuild
• 682-add-sphinx-copybutton
• 7.x
• 756-read-cals-from-files
• 756-read-from-file
• 804-pydata-sphinx-theme
• 876/vBinary
• 876/vInt
• 876/vText
• 906-dependency-groups
• 909-image-creation-invalid-params
• 952-lots-of-warnings-in-documentation-unclear-class-reference
• 991-documentation-contribution-guide-improvement-ideas
• 996-document-precommit
• 997-upgrade-guide
• 999/event_duration_positive
• Adding-params-to-init
• Issue-610
• Issue_1238
• N0ury-master
• NicoHood-escape_fix
• __doc__
• abes-patch
• add-all-attribute
• add-codeowners
• add-coverage-badge
• add-ical-value-date-datetime-duration
• add-ical-value-frequency-month-inline
• add-ical-value-time-geo-utcoffset
• add-ical-value-vdate
• add-ical-value-vdatetime
• add-ical-value-vduration
• add-ical-value-vfrequency
• add-ical-value-vgeo
• add-ical-value-vmonth
• add-ical-value-vperiod
• add-ical-value-vutcoffset
• add-ical-value-vweekday
• add-maintainer
• add-missing-uids-issue-315
• add-nixos-installation-docs
• add-python-typing-support
• add-readthedocs-badge
• add-repology-badge
• add-rfc-documentation
• add-spell-style-grammar-checker-vale
• add-sphinx-llms-txt
• add-tag-variable-to-release-flow
• add-type-hints
• add-type-hints-duration-properties
• add-type-hints-init-prop-values
• add-type-hints-prop-values
• add-type-hints-remaining-prop-values
• add-vcaladdress-new-method-issue-870
• add_alarms_and_recurrence_examples
• add_changelog_to_doc
• add_eq_vDDDTypes_issue_308
• add_max_error_length
• adjust_assertion_in_max_error_length
• ai-policy-933
• ai-policy-rev-2026-04-07
• aleksamilicev-Issue#1158
• all-fixes
• arjun/docs-save-calendar-file
• arjun/fix-component-python-links
• arjun/type-vfrequency
• auto-format
• badge
• badge-4.x
• branch_for_coverage
• bugfix-333
• bugfix-335
• bump-pypy-311
• change-log-fixes
• change-log-omissions
• change-run-condition
• changelog-fix-20260211
• changelog-guide
• changes
• changes-move-api-docs
• check-dist
• check-rtd-build-skip-requirements-848
• clara/1142/timezone_support
• clean-up-1159
• cleanup-1120
• coc-3.0
• code-of-conduct-907
• code-readability
• collaborator
• comparing
• consolidate-setter-methods
• contrib-20260218-023555
• contributing-link
• copilot/fix-dependency-graph-issue
• copilot/sub-pr-1028
• copilot/update-contributor-credits
• copy-button-exclude-prompts
• coveralls-action
• credits-template
• cross-component-links-994
• dependabot/github_actions/github-actions-1665b4e347
• dependabot/github_actions/github-actions-1893dd32ff
• dependabot/github_actions/github-actions-1cc54e3a68
• dependabot/github_actions/github-actions-674967a53d
• dependabot/github_actions/github-actions-76468cb07f
• dependabot/github_actions/github-actions-88dfb18256
• dependabot/github_actions/github-actions-a331d3ec2d
• dependabot/github_actions/github-actions-dc500464ed
• deprecate-foldline-issue-1011
• doc-google-stye-func
• doc-update
• docs-1158-alarm-fixes
• docs-1158-availability
• docs-1158-calendar-fixes
• docs-add-api
• docs-caselessdict-google-style
• docs-error
• docs-fix-broken-links
• docs-follow-up-919
• docs-http-server
• docs-py-12
• docs-py-38+
• docs-tox
• docs/1244-alarm-repeat-duration-docstrings
• docs/add_vrecur_example
• docs/changelog-subheadings
• docs/changelog-subheadings-complete
• docs/contributor-filename-conflict
• docs/error-tolerant-parsing
• docs/fix-broken-links-cal-event
• docs/free-busy-component-links
• docs/improve-docstrings
• docs/issue-directive-1094
• docs/parser-google-style
• docstring-calendar-description
• docstring-caselessdict
• docstring-format-737
• docstring-url-property-1244
• doctest
• doctest-docs-only
• doctests_in_windows
• document-calendar-from-ical
• document-maintenance
• document-release-process
• document-tzdata-dependency
• document-vText
• document-vint-new-1118
• documentation
• documentation-ci
• documentation-links-broken-959
• drop-compat
• email
• endash-ellipsis-only
• enforce-ruff-formatting
• ennamarie19-feat/oss-fuzz-integration
• error_handling_2
• example_onComponent
• feat-python-314
• feat/calendar-journals-property
• feat/fuzzing-corpus
• feat/improve-fuzzing-coverage
• feat/improve-fuzzing-harness
• feat/oss-fuzz-integration
• feat/unicode-nfc-normalization-fork
• feature/add-with-uid
• feature/documentation-vDatetime
• feature/issue-1065-new-subcomponents-parameter
• feature/recurrence_id
• file_stucture_overview
• first-time-contributors-934
• fix-1000-premature-merge
• fix-1226-escape-char-bytes
• fix-1289-vbinary-bytes
• fix-1426-jcal-value-param
• fix-322
• fix-351-lenient-property-name
• fix-464
• fix-466-changelog
• fix-500
• fix-526
• fix-broken-links-component-docs
• fix-change-log-1241
• fix-changelog
• fix-deprecated
• fix-docstring-parameters-style-guide
• fix-docstring-style
• fix-doctest
• fix-duplicate-issue-templates
• fix-good-first-issue-links
• fix-icalendar-tool
• fix-issue-1277
• fix-issue-321-dst-offset-assertion
• fix-issue-355-url-escaping
• fix-issue-557
• fix-issue-641-ec5a
• fix-issue-898-todo-end
• fix-py-prefix-property-docstring
• fix-timezone-placement-issue-844
• fix-todo-duration-without-dtstart-issue-867
• fix-value-parameter-issue-349
• fix/1005/remove-deprecation-warning
• fix/1158-doc-links
• fix/1405-deprecation-wrapper
• fix/1405-use-deprecation-wrapper
• fix/393
• fix/865-valarm-factory-methods
• fix/876-vPeriod
• fix/add-type-hints-encoding
• fix/attendees-broken-link
• fix/broken-class-refs-enums
• fix/broken-pr-reference
• fix/component-from-ical-return-type-doc
• fix/coveralls-pip-conflict
• fix/deep-component-walk-dos
• fix/deprecate-private-functions
• fix/deprecate-q-join-q-split-foldline
• fix/docs
• fix/escape-char-bytes
• fix/explicit-from-ical-file-paths
• fix/google-style-docstrings-timezone
• fix/issue-1056-tzwin-utc
• fix/issue-1072-attr-docstrings
• fix/issue-1129-typing
• fix/issue-1244-pythonic-docstrings
• fix/issue-1277
• fix/pending-tests-should-be-skipped
• fix/property-items-recursion
• fix/remove-dead-else-branches-parser-tools
• fix/strict-binary-base64-validation
• fix/vale-doc-link
• fix/vbinary-bytes
• fix/vbinary-raw-bytes
• fix/vdatetime-bounds-check
• fix/walk-recursion
• fixPrint
• fix_466
• fix_compare
• fix_greenland
• fix_issue_525
• fix_issue_629
• fix_issue_691
• fix_timezone
• fixdocstringComponent
• fund
• funding-links
• git-genie/issue-1306
• github-actions
• hw6-feature
• ical-value-vGeo-issue-876
• icalendar-editable
• icalendar-python-version
• icalendar_new_classes_document
• ijsbol/876/vFloat
• improve-api-usability-issue-857
• improve-contributing-docs-issue-890
• improve-coverage-report
• improve-rtd-pull-request-preview-git-diff
• improve-test-coverage-698
• improved-property-setters-issue-860
• install-fedora
• internal-1081-error-tolerant-test-refactor
• interspinx
• is-broken
• issue#821-stdin-parsing
• issue-1008
• issue-1016-caselessdict-eq
• issue-1033
• issue-1047
• issue-1050-lazy-calendar
• issue-1060-vcard-namedtuple
• issue-1066-calendar-uid
• issue-1073-pyodide-import
• issue-1087-vbroken
• issue-1147
• issue-1202
• issue-1237
• issue-124
• issue-127-categories-comma-escaping
• issue-1293
• issue-130
• issue-137-vcard-semicolons
• issue-152
• issue-156-rdate-with-period
• issue-158-lazy-parsing
• issue-165
• issue-187
• issue-218
• issue-219
• issue-27
• issue-278
• issue-279-2
• issue-301
• issue-314-timezone-subcomonent-must-not-use-date-but-datetime
• issue-315
• issue-318-skip-value-parameter-for-default-date-time
• issue-318-skip-value-parameter-for-default-date-time1
• issue-335
• issue-336
• issue-419-temp-fix
• issue-429-changelog-release-5.0.0
• issue-432-custom-components
• issue-443
• issue-466-add-deployment-on-tags
• issue-571-invalid-workflow
• issue-596
• issue-652
• issue-654
• issue-655
• issue-655-categories
• issue-655-color
• issue-655-properties
• issue-657-rfc-9074
• issue-658
• issue-662-event-properties
• issue-662-todo
• issue-67
• issue-672-hook
• issue-686-pyproject.toml
• issue-701
• issue-712
• issue-716-alarms
• issue-740-uid
• issue-742
• issue-763
• issue-778
• issue-780
• issue-781
• issue-798
• issue-802
• issue-816
• issue-826
• issue-828
• issue-836
• issue-841
• issue-843-new-event
• issue-864
• issue-884
• issue-899
• issue-918-write-x-wr-calname-compatibility
• issue-919-version
• issue-932-changelog-clarification
• issue-959
• issue-977-deprecate-python-versions
• issue-978-jcal
• issue-987
• issue-987-parser
• issue-987-prop
• issue1158-usage-links
• issue698-freebusy-duration-tests
• issue698-freebusy-validation
• issue_268_support_for_byweekday
• issue_350
• issue_354
• issue_698
• issue_742_vdatetime
• license-edit-sashank
• link-security-advisory
• linkl-rfc-5545-s3.3.10
• links
• localdatetime
• main
• maintenance-docs-version-switcher
• maintenance-rebuild-rtd-latest
• make-livehtml-src-931
• master
• maurits-no-more-plone-tests
• maurits-no-universal-wheel
• maurits-require-python38
• maurits-test-plone-app-event
• minor-export-fix
• move-design-section
• move-new-changes-section
• niccokunzmann-4.x-py34-py35
• niccokunzmann-add-issue-templates
• niccokunzmann-alpine
• niccokunzmann-docs-python-version-matrix
• niccokunzmann-ical2jcal
• niccokunzmann-inherited-members
• niccokunzmann-issue-Bug-type
• niccokunzmann-maintainers-add-pyproject.toml
• niccokunzmann-make-dev
• niccokunzmann-patch-1
• niccokunzmann-patch-2
• niccokunzmann-patch-3
• niccokunzmann-pypy-4.x
• niccokunzmann-release-docs-edit
• niccokunzmann-shorten-example
• niccokunzmann-test-py37
• niccokunzmann-update-readme
• niccokunzmann-update-release-procedure
• normalise-conf-prop
• omit-types-from-docstrings
• optional-coverage
• optional-typing-extensions
• osc-1072-google-style
• osc/1286-skip-ci-tasks
• osc/626-codeblock-pycon-usage
• osc/876-vfrequency-ical-value
• patch-1
• patch-2
• patch-3
• patch-4
• patch-5
• period_timezone
• pr-634
• pr-template-keep-original-issue-open
• prepare-7.0.3
• print-doctest-failure
• probable-bugs
• prop-docstring
• py311
• py38
• pypy39
• python3.13
• readme-update
• refactor-set-duration-issue-886
• refactor-test-1
• refactor-test-2
• refactor-test-3
• refactor-test-4
• refactor-test-5
• refactor-test-6
• refactor-test-7
• refactor-test-encoding
• refactor-test-multiple
• refactor-test-remove-unused-file
• refactor_test_escaping
• refactor_test_parameters_class
• refactor_test_quoting
• refactor_test_reccurence
• refactor_test_unicode_params
• related-vobject
• release
• release-4.1.1
• release-5.0.0
• release-5.0.1
• release-5.0.10
• release-5.0.14
• release-5.0.2
• release-5.0.6
• release-6.3.2
• release-7.0.0
• release-7.0.0a3
• release-7.0.1
• release-7.0.2
• release-7.0.3
• release-message
• release-to-github
• release-update-version-switcher
• remove-abe-101-codeowner
• remove-confusing-sentence
• remove-getattr
• remove-misleading-tox_env-makefile
• remove-pytz
• remove-tidelift-893
• remove-uid-generator
• rename-master-to-main
• rename-private-functions-final
• reorder-docs-jobs
• reproduce-fuzz-errors
• restructure-docs
• restructure_test_issue_82
• rfc-7529
• rfc-docs
• rm-dead-links
• rtd-pr-preview-clean-up
• ruff
• ruff-1
• ruff-10
• ruff-2
• ruff-3
• ruff-4
• ruff-5
• ruff-6
• ruff-7
• ruff-8
• ruff-9
• ruff-cal
• ruff-changelog
• ruff-formmat
• ruff-prop
• ruff-show-difference-ci
• ruff-show-difference-ci-2
• ruff-tests
• ruff-tests-fix
• scheduling-attributes
• sec/codeql-safety
• security
• semiprime-4.x-issue518
• setup
• setuptools-depr
• split-up-contributing-paths-929
• stevepiercy-patch-1
• support-python-3.13
• syntax-highlight-config
• test-conference-normalize-edge-cases
• test-conference-parameter-normalization-edge-cases
• test-deprecate-for-version-8
• test-issue-1275
• test/unit_prop
• test_restructure1
• test_restructure_index_error
• test_restructure_issue_100_184
• test_restructure_issue_101
• test_restructure_issue_104
• test_restructure_issue_112
• test_restructure_issue_157
• test_restructure_issue_168
• test_restructure_issue_273
• test_restructure_issue_335
• test_restructure_issue_345
• test_restructure_issue_53
• test_restructure_issue_55
• test_restructure_issue_58
• test_restructure_issue_70
• test_restructure_test_encoding_create_from_ical
• test_restructure_test_encoding_to_ical
• test_restructure_test_issue_142_143
• test_restructure_test_issue_178
• tidy-pr-issue-templates
• timedelta-not-linked-in-documentation-951
• timezone-generation
• tirkarthi-fix-assert
• towncrier-for-change-log
• tox-version
• tutorial-getting-started
• tweak-contributing
• type-hints/batch-1
• types-for-tools
• tzid-forward-reference
• unicode-bom
• upd
• update-CI
• update-compatibility
• update-read-the-docs
• update-ruff-0.15.2
• update-ruff-in-tox
• update-ruff-version
• v4.1.1
• v4.1.2
• v5.0.0
• v5.0.1
• v5.0.10
• v5.0.11
• v5.0.12
• v5.0.13
• v5.0.14
• v5.0.2
• v5.0.3
• v5.0.4
• v5.0.5
• v5.0.6
• v5.0.7
• v5.0.8
• v5.0.9
• v6.0.0
• v6.0.0a0
• v6.0.1
• v6.1.0
• v6.1.1
• v6.1.2
• v6.1.3
• v6.2.0
• v6.3.0
• v6.3.1
• v6.3.2
• v7.0.0
• v7.0.0a1
• v7.0.0a2
• v7.0.0a3
• v7.0.1
• v7.0.2
• v7.0.3
• v7.1.0
• v7.1.1
• v7.1.2
• v7.1.3
• vale-docs
• version-fix
• version-switcher-825
• version-switcher-test
• vgeo
• vtext-ical-value
• workflow
• zoneinfo

Build # 24555526342

Build Type

Pull #1316

github

Committed by web-flow

Commit Message

Merge 750c1c61e into c56e31d3a

Pull Request Pull Request #1316: Improved docstring for string_parameter (Google Style)

Coverage Stats

747 of 769 branches covered (97.14%)

Branch coverage included in aggregate %.

12281 of 12558 relevant lines covered (97.79%)

6.84 hits per line