Commit 0af1a97
authored
Feature/bcss 20436 calendar picker util markdown doc and docstrings (#48)
<!-- markdownlint-disable-next-line first-line-heading -->
## Description
<!-- Describe your changes in detail. -->
Adding a markdown documents detailing how to use the calendar picker
util.
Added doc-strings to all of the methods in the calendar picker util.
Also includes changes the the calendar picker util that were created in
[PR 46](#46)
## Context
<!-- Why is this change required? What problem does it solve? -->
Allows for the team to understand how to use the util and each method by
either reading the markdown document or the doc strings under each
method.
## Type of changes
<!-- What types of changes does your code introduce? Put an `x` in all
the boxes that apply. -->
- [x] Refactoring (non-breaking change)
- [x] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would change existing
functionality)
- [ ] Bug fix (non-breaking change which fixes an issue)
## Checklist
<!-- Go over all the following points, and put an `x` in all the boxes
that apply. -->
- [x] I am familiar with the [contributing
guidelines](https://github.com/nhs-england-tools/playwright-python-blueprint/blob/main/CONTRIBUTING.md)
- [x] I have followed the code style of the project
- [ ] I have added tests to cover my changes (where appropriate)
- [x] I have updated the documentation accordingly
- [ ] This PR is a result of pair or mob programming
---
## Sensitive Information Declaration
To ensure the utmost confidentiality and protect your and others
privacy, we kindly ask you to NOT including [PII (Personal Identifiable
Information) / PID (Personal Identifiable
Data)](https://digital.nhs.uk/data-and-information/keeping-data-safe-and-benefitting-the-public)
or any other sensitive data in this PR (Pull Request) and the codebase
changes. We will remove any PR that do contain any sensitive
information. We really appreciate your cooperation in this matter.
- [x] I confirm that neither PII/PID nor sensitive data are included in
this PR and the codebase changes.1 parent 98e88de commit 0af1a97
File tree
3 files changed
+601
-57
lines changed- docs/utility-guides
- tests/smokescreen
- utils
3 files changed
+601
-57
lines changed
0 commit comments