Skip to content

[DOCS] Fix QN Index docs regarding dir keyword argument #1615

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

Merged
merged 3 commits into from
Mar 20, 2025

Conversation

mtfishman
Copy link
Member

See https://itensor.discourse.group/t/index-direction/977.

@emstoudenmire the controversial thing I did here was not show the dir keyword argument at all, I can't think of a reason why an end user should be using that rather than creating a new Index and calling dag on it.

Copy link

codecov bot commented Feb 9, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 79.44%. Comparing base (3fa632c) to head (8c76e20).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1615   +/-   ##
=======================================
  Coverage   79.44%   79.44%           
=======================================
  Files          64       64           
  Lines        5083     5083           
=======================================
  Hits         4038     4038           
  Misses       1045     1045           

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

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@mtfishman mtfishman requested a review from emstoudenmire March 20, 2025 19:58
Copy link
Collaborator

@emstoudenmire emstoudenmire left a comment

Choose a reason for hiding this comment

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

Yes, it's a good idea to just have users wrap the constructor in dag or call dag afterward rather than use the keyword argument. So I approve this PR.

@mtfishman mtfishman merged commit d7d7387 into main Mar 20, 2025
15 checks passed
@mtfishman mtfishman deleted the ITensors_qnindex_docs branch March 20, 2025 22:53
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.

2 participants