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

fixes type restriction on input arguments and Improve docs #52

Merged
merged 3 commits into from
Mar 28, 2024

Conversation

lazarusA
Copy link
Contributor

This adds 3 main things

  1. less restrictive type input arguments, no restrictions
  2. improved documentation
  3. YAXArray example with mapCube (for out of memory calculations)

I didn't and will not look at the auto formatting issues, please feel free to do so. CI or additional comments I would consider. This was a good sprint. Cheers!

@MartinuzziFrancesco
Copy link
Member

should the documenter github action be removed? if not could you look into the cause of failure?

@lazarusA
Copy link
Contributor Author

yeah, it looks like that's the issue. Apparently, I'm not up to date with deploy workflow. Let's see if it works now.

@MartinuzziFrancesco
Copy link
Member

that did it apparently

@lazarusA
Copy link
Contributor Author

the only thing missing is the formatter. How to you do it? what's the workflow to apply that. I usually don't enforce it, hence I'm not familiar with it.

Copy link

codecov bot commented Mar 28, 2024

Codecov Report

Attention: Patch coverage is 99.73475% with 1 lines in your changes are missing coverage. Please review.

Project coverage is 92.22%. Comparing base (ed6e091) to head (c8ac13c).

Files Patch % Lines
src/utils.jl 0.00% 1 Missing ⚠️
Additional details and impacted files
@@           Coverage Diff           @@
##             main      #52   +/-   ##
=======================================
  Coverage   92.22%   92.22%           
=======================================
  Files          12       12           
  Lines         900      900           
=======================================
  Hits          830      830           
  Misses         70       70           

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

@MartinuzziFrancesco
Copy link
Member

I should have added an automatic formatter actually, I'm curios to see if it works. It should open a pr with the formatted code. If that doesn't work I'll just format myself

@MartinuzziFrancesco MartinuzziFrancesco merged commit 3682d10 into awesome-spectral-indices:main Mar 28, 2024
5 of 6 checks passed
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