Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
A clear and descriptive title (No issue numbers please)
Types of changes
This PR implements the following changes:
(tick any that apply)
📋 Additional details
If you have implemented new features or behaviour
Provide a description of the addition in as many details as possible.
Provide justification of the addition.
Provide a runnable example of use of your addition. This lets reviewers
and others try out the feature before it is merged or makes it's way to release.
If you have changed current behaviour...
Describe the behaviour prior to you changes
Describe the behaviour after your changes and justify why you have made the changes,
Please describe any breakages you anticipate as a result of these changes.
Does your change alter APIs or existing exposed methods/types?
If so, this may cause dependency issues and breakages, so the maintainer
will need to consider this when versioning the next release.
If you are implementing changes that are intended to increase performance, you
should provide the results of a simple performance benchmark exercise
demonstrating the improvement. Especially if the changes make code less legible.
☑️ Checklist
docs/src/
.