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

Add in user documentation for configs #186

Open
wants to merge 3 commits into
base: 733-review-config-newest
Choose a base branch
from

Conversation

NathanKelly-ONS
Copy link
Collaborator

User documentation for configs

Summary

Created a readme file for the new configs. PR to merge into the 733 branch as the 733 branch is the branch that actually implements the new config, so will need to familiarise yourself with the new config as part of the review. It's a fairly simple change from a user-facing perspective, just splitting the config into a user config and a dev config. The user config has the bucket name, filepaths and period information, and the dev config has everything else.

Type of Change

  • Bug fix
  • New feature
  • Breaking change
  • Documentation update
  • Other (please describe):

Checklists

This pull request meets the following requirements:

Creator Checklist

  • Installable with all dependencies recorded
  • Runs without error
  • Follows PEP8 and project-specific conventions
  • [N/A] Appropriate use of comments, for example, no descriptive comments
  • [N/A] Functions documented using Numpy style docstrings
  • [N/A] Assumptions and decisions log considered and updated if appropriate
  • [N/A] Unit tests have been updated to cover essential functionality for a reasonable range of inputs and conditions
  • [N/A] Other forms of testing such as end-to-end and user-interface testing have been considered and updated as required

If you feel some of these conditions do not apply for this pull request, please
add a comment to explain why.

Reviewer Checklist

  • Test suite passes (locally as a minimum)
  • Peer reviewed with review recorded

Additional Information

Please provide any additional information or context that would help the reviewer understand the changes in this pull request.

Related Issues

Link any related issues or pull requests here.

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.

1 participant