test expected output

[Bchass]

Description

Fixes #471

Changes

• update examples to try and line up with what doctest expects

Checklist

• Use ruff and pylint for errors related to code style and formatting.
• Verify all previous and newly added unit tests pass in pytest.
• Check the documentation build does not lead to any failures. Sphinx build can be checked locally for any failures related to your PR
• Use linkcheck to check for broken links in the documentation
• Use doctest to verify the examples in the function docstrings work as expected.

[purva-thakre]

You might want to rebase your PR. What you're working with is from an older commit.

Also, you might have to make changes to the code of the function to get to array output (probably) which is what I referred to in the issue discussion.

[purva-thakre]

@Bchass After you rebase this branch, you could try to figure out where the function changes a numpy array to a 2D list at each step by making python print the variable type after each step.

toqito/toqito/matrices/cyclic_permutation.py

Lines 57 to 62 in eb58207

	p_mat = np.zeros((n, n), dtype=int)
	np.fill_diagonal(p_mat[1:], 1)
	p_mat[0, -1] = 1
	result_mat = np.linalg.matrix_power(p_mat, k)
	return result_mat

For example, temporarily use print(type(variable_name)) after each line in the function code. If you use the function, you should be able see where the function transitions from manipulating a np.ndarray type to a 2D list.

Hopefully, this makes sense? Again, I haven't had the chance to dig into the issue yet but this is what my first step would have been.

[Bchass]

Thanks for the info! I'll look into it more at some point this weekend.

[Bchass]

@purva-thakre Stepping through the function, it never converted to a 2D list. It boiled down to whitespace and how I was calling the function in the examples.

Came across: https://numpy.org/doc/stable/reference/generated/numpy.set_printoptions.html and was able to format the result how doctest expects it.

Edit: resolved the conflicts but the docstring job is now failing. Looks like the changes I made are breaking some other examples. I'll look into this furher.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.1%. Comparing base (f613473) to head (812288d).
Report is 3 commits behind head on master.

Additional details and impacted files

@@           Coverage Diff            @@
##           master    #486     +/-   ##
========================================
- Coverage    98.1%   98.1%   -0.1%     
========================================
  Files         161     161             
  Lines        3096    3095      -1     
  Branches      753     752      -1     
========================================
- Hits         3038    3037      -1     
  Misses         37      37             
  Partials       21      21             

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

[purva-thakre]

Stepping through the function, it never converted to a 2D list. It boiled down to whitespace and how I was calling the function in the examples.

That's interesting!

[Bchass]

More failures to investigate tomorrow

[purva-thakre]

@Bchass You can ignore the drop in pytest coverage. The linkcheck workflow passes now, previous failure could have been related to the website being down or something.