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

Update documentation on settings validation in response to code changes #2149

Merged

Conversation

ThomasHepworth
Copy link
Contributor

Type of PR

  • BUG
  • FEAT
  • MAINT
  • DOC

Is your Pull Request linked to an existing Issue or Pull Request?

Give a brief description for the solution you have provided

Updates the settings validation documentation following some fundamental changes to the way it is coded.

The code has largely moved towards a more functional approach, simplify the process of extending it. As a result, a lot of the documentation has been stripped back and simplified.

PR Checklist

  • Added documentation for changes
  • Added feature to example notebooks or tutorial (if appropriate)
  • Added tests (if appropriate)
  • Updated CHANGELOG.md (if appropriate)
  • Made changes based off the latest version of Splink
  • Run the linter
  • Run the spellchecker (if appropriate)

@ThomasHepworth ThomasHepworth added documentation Improvements or additions to documentation validation labels Apr 23, 2024
@ThomasHepworth ThomasHepworth requested a review from RossKen April 23, 2024 15:04
Copy link
Member

@RobinL RobinL left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

@ThomasHepworth ThomasHepworth merged commit ad28a62 into master Apr 30, 2024
5 checks passed
@ThomasHepworth ThomasHepworth deleted the docs/updating_settings_validation_documentation branch April 30, 2024 13:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation validation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants