rafaqz / DimensionalData.jl

Named dimensions and indexing for julia arrays and other data
https://rafaqz.github.io/DimensionalData.jl/stable/
MIT License
262 stars 38 forks source link

Documentation (docstrings and site) updates #741

Closed abhro closed 1 week ago

abhro commented 2 weeks ago

Main changes:

rafaqz commented 2 weeks ago

Hi, thanks for this!

Could you revert the files where only whitespace changed? Just so we can see what the real changes are to review

(Eg the README, benchmarks.jl, style.css, integrations.jl, all the tests, probably a few more)

There are also whitespace changes mixed into some other files, especially the extensions like DimensionalDataCategoricalArraysExt.jl and DimseiomalDataMakieExt.jl where there are lines of code changed rather than just docs. It looks like its just for whitespace, but we don't want code blame tracing back to this PR.

This is no drama, just housekeeping. The docs edits are great, it's really appreciated.

abhro commented 2 weeks ago

No worries! I completely understand about keeping the PRs focused! If there's any drama, it's between me and my text editor because it keeps complaining about whitespace lol. I'll get to the revert as soon as I can. Thank you!!

abhro commented 1 week ago

Revert commit for c54bc6c pushed! Thank you!

codecov[bot] commented 1 week ago

Codecov Report

Attention: Patch coverage is 50.00000% with 1 line in your changes missing coverage. Please review.

Project coverage is 83.95%. Comparing base (d927b77) to head (d0c7170). Report is 109 commits behind head on main.

Files Patch % Lines
src/Dimensions/primitives.jl 0.00% 1 Missing :warning:
Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #741 +/- ## ========================================== - Coverage 87.23% 83.95% -3.28% ========================================== Files 43 47 +4 Lines 3446 4270 +824 ========================================== + Hits 3006 3585 +579 - Misses 440 685 +245 ```

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

abhro commented 1 week ago

Hi! Sorry for the delay, the comments had been sitting in "pending" for a bit, and I assumed that it was pending to get approved by a moderator.

lazarusA commented 1 week ago

it looks like some of the doctests are failing now. Did the expected output changed? then it will need to be modified. Or is an issue of missing blank spaces?

rafaqz commented 1 week ago

You should be able to run the doctests again with the fix=true keyword to fix it

abhro commented 1 week ago

It is newline related, and Documenter.jl is a bit finicky in how it separates input/output for REPL doctests. I'll be pushing a commit soon to fix it. Thanks for bringing it to my attention!

rafaqz commented 1 week ago

Thanks again!