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

Some docs fixes #103

Merged
merged 5 commits into from
Feb 2, 2024
Merged

Some docs fixes #103

merged 5 commits into from
Feb 2, 2024

Conversation

leburgel
Copy link
Contributor

@leburgel leburgel commented Feb 1, 2024

Some fixes for docstrings that appeared as missing in lib/tensors. Some of them were actually missing and I only added the ones I was confident about adding, and some of them weren't appearing because they were already referenced somewhere else so I had to mess with the type specifiers a bit.

The only thing here I'm not too sure about are the references to blocksectors in lib/spaces. I found two relevant documented methods so I added these both explicitly, but it feels like maybe there should just be one docstring for an overarching blocksectors(::VectorSpace)?

Copy link

codecov bot commented Feb 1, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (e6fe747) 81.40% compared to head (32e573d) 81.40%.

Additional details and impacted files
@@           Coverage Diff           @@
##           master     #103   +/-   ##
=======================================
  Coverage   81.40%   81.40%           
=======================================
  Files          42       42           
  Lines        5565     5565           
=======================================
  Hits         4530     4530           
  Misses       1035     1035           

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

src/tensors/tensor.jl Outdated Show resolved Hide resolved
src/tensors/tensor.jl Outdated Show resolved Hide resolved
@Jutho
Copy link
Owner

Jutho commented Feb 2, 2024

Thanks. Looks good, up to one comment.

@leburgel
Copy link
Contributor Author

leburgel commented Feb 2, 2024

Also snuck in a small typo fix in the Deligne product docstring while I"m at it.

@Jutho Jutho merged commit 889c518 into Jutho:master Feb 2, 2024
13 checks passed
@leburgel leburgel deleted the lb/docs_fixes branch February 2, 2024 14:11
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.

3 participants