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

Misc doc changes #268

Merged
merged 8 commits into from
May 23, 2024
Merged

Misc doc changes #268

merged 8 commits into from
May 23, 2024

Conversation

ronanstokes-db
Copy link
Contributor

Proposed changes

Miscellaneous doc changes for the coming release

Types of changes

What types of changes does your code introduce to dbldatagen?
Put an x in the boxes that apply

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Change to tutorials, tests or examples
  • Non code change (readme, images or other non-code assets)
  • Documentation Update (if none of the other choices apply)

Checklist

Put an x in the boxes that apply. You can also fill these out after creating the PR.
If you're unsure about any of them, don't hesitate to ask. We're here to help!
This is simply a reminder of what we are going to look for before merging your code.

  • Lint and unit tests pass locally with my changes
  • I have added tests that prove my fix is effective or that my feature works
  • I have added necessary documentation (if appropriate)
  • Any dependent changes have been merged and published in downstream modules
  • Submission does not reduce code coverage numbers
  • Submission does not increase alerts or messages from prospector / lint

Further comments

If this is a relatively large or complex change, kick off the discussion by explaining why you chose the solution you
did and what alternatives you considered, etc...

@ronanstokes-db ronanstokes-db requested a review from a team as a code owner May 6, 2024 17:58
@ronanstokes-db ronanstokes-db requested review from GeekSheikh and removed request for a team May 6, 2024 17:58
@ronanstokes-db ronanstokes-db self-assigned this May 6, 2024
@ronanstokes-db ronanstokes-db added the documentation Improvements or additions to documentation label May 6, 2024
docs/source/textdata.rst Outdated Show resolved Hide resolved
Copy link

codecov bot commented May 23, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.14%. Comparing base (02d529e) to head (e8922c7).

Additional details and impacted files
@@           Coverage Diff           @@
##           master     #268   +/-   ##
=======================================
  Coverage   92.14%   92.14%           
=======================================
  Files          23       23           
  Lines        2788     2788           
  Branches      477      477           
=======================================
  Hits         2569     2569           
  Misses        130      130           
  Partials       89       89           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@ronanstokes-db ronanstokes-db merged commit b28602d into master May 23, 2024
5 checks passed
@ronanstokes-db ronanstokes-db deleted the feature_doc_updates_0424 branch May 23, 2024 23:03
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants