feat: Rename kwarg with_aux to include_auxdata in pyhf.Workspace.data API

[kratsg]

Pull Request Description

Closes #1561. This harmonizes the API a little more by renaming with_aux to include_auxdata in ws.data() calls to match model.expected_data().

Checklist Before Requesting Reviewer

• Tests are passing
• "WIP" removed from the title of the pull request
• Selected an Assignee for the PR to be responsible for the log summary

Before Merging

For the PR Assignees:

• Summarize commit messages into a comprehensive review of the PR

* Rename keyword argument in pyhf.Workspace.data with_aux to include_auxdata
  - Harmonize the API between workspace and model
  - Possible breaking API change with pyhf v0.6.2

[codecov]

Codecov Report

Merging #1562 (47947cc) into master (29e15c2) will not change coverage.
The diff coverage is 100.00%.

@@           Coverage Diff           @@
##           master    #1562   +/-   ##
=======================================
  Coverage   97.70%   97.70%           
=======================================
  Files          63       63           
  Lines        4050     4050           
  Branches      576      576           
=======================================
  Hits         3957     3957           
  Misses         54       54           
  Partials       39       39           

Flag	Coverage Δ
contrib	25.40% <50.00%> (ø)
unittests	97.48% <100.00%> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files	Coverage Δ
src/pyhf/workspace.py	100.00% <100.00%> (ø)

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 29e15c2...47947cc. Read the comment docs.

[matthewfeickert]

I'd suggest not making the change that CodeFactor suggests as it slows things down for no benefit, but other than that this all looks good. I know that CodeFactor will complain but we can manually ignore it.

I guess this PR is technically API breaking but only if people are actively using the kwarg so I'm not really expecting this to break people. 👍

[alexander-held]

Thanks for addressing this so quickly! It's a breaking change for cabinetry, but with this going into v0.6.3 (which introduces another breaking change anyway), that's not an issue at all from cabinetry's side.

[matthewfeickert]