Document and rename experimental_preserve_dimensions

PennyLaneAI / catalyst

A JIT compiler for hybrid quantum programs in PennyLane

https://docs.pennylane.ai/projects/catalyst

Apache License 2.0

130 stars 29 forks source link

Document and rename experimental_preserve_dimensions #904

Closed josh146 closed 3 months ago

josh146 commented 3 months ago

Context: The experimental_preserve_dimensions argument was hard to decipher and not documented.

Description of the Change:

Renames the function to allow_array_resizing.
Adds docstring documentation
Extends sharp bits documentation.

Benefits: As above.

Possible Drawbacks: n/a

Related GitHub Issues: n/a

github-actions[bot] commented 3 months ago

Hello. You may have forgotten to update the changelog! Please edit doc/changelog.md on your branch with:

A one-to-two sentence description of the change. You may include a small working example for new features.
A link back to this PR.
Your name (or GitHub username) in the contributors section.

codecov[bot] commented 3 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Please upload report for BASE (v0.7.0-rc@5d910b6). Learn more about missing BASE report.

Additional details and impacted files

```diff @@ Coverage Diff @@ ## v0.7.0-rc #904 +/- ## ============================================ Coverage ? 97.97% ============================================ Files ? 71 Lines ? 10470 Branches ? 954 ============================================ Hits ? 10258 Misses ? 169 Partials ? 43 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.