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

Update faq.md #414

Merged
merged 10 commits into from
Jul 27, 2024
Merged

Update faq.md #414

merged 10 commits into from
Jul 27, 2024

Conversation

aasdelat
Copy link
Contributor

Remake of the "How do I subset a Cube? " section in order to incorporate information of various ways of selection, including selecting a variable based on the values of another variable with which it shares a dimension.

Remake of the "How do I subset a Cube? " section in order to incorporate information of various ways of selection, including selecting a variable based on the values of another variable with which it shares a dimension.
````@ansi howdoi
y = YAXArray(axes, reshape(1:3600, (10, 10, 36)))
````
````@ansi howdoi
Copy link
Collaborator

Choose a reason for hiding this comment

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

all the second ansi blocks are not necessary. That is the output from the previous one, after execution.

Copy link
Contributor Author

@aasdelat aasdelat Jul 22, 2024

Choose a reason for hiding this comment

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

But I separate them in order for the user to easily copy the input and paste and run it in the console in a quick way. If both blocks were the same, it would be not so ease. The button on the up-right corner of the block, would copy both the input and the output.

Perhaps the style of the blocks should be different for the input than for the output?.

Copy link
Collaborator

@lazarusA lazarusA Jul 22, 2024

Choose a reason for hiding this comment

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

you can always see a copy button in the output cells (and input and output are in different cells):
Screenshot 2024-07-22 at 17 04 52

be different for the input than for the output?.

Yes, we could try different styles.

Copy link
Contributor Author

@aasdelat aasdelat Jul 23, 2024

Choose a reason for hiding this comment

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

How I can achieve this behavior? Could you suggest me a link to a documentation page for this?

Copy link
Contributor Author

@aasdelat aasdelat Jul 23, 2024

Choose a reason for hiding this comment

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

I have just seen how to do it. I do not have to explicitly add the output. It is automatically generated.

Copy link

codecov bot commented Jul 22, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 68.30%. Comparing base (778f635) to head (59d23fc).
Report is 13 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master     #414      +/-   ##
==========================================
+ Coverage   68.15%   68.30%   +0.14%     
==========================================
  Files          12       12              
  Lines        1771     1773       +2     
==========================================
+ Hits         1207     1211       +4     
+ Misses        564      562       -2     

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

@coveralls
Copy link

coveralls commented Jul 22, 2024

Pull Request Test Coverage Report for Build 10094752696

Warning: This coverage report may be inaccurate.

This pull request's base commit is no longer the HEAD commit of its target branch. This means it includes changes from outside the original pull request, including, potentially, unrelated coverage changes.

Details

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • 26 unchanged lines in 1 file lost coverage.
  • Overall coverage decreased (-0.9%) to 67.494%

Files with Coverage Reduction New Missed Lines %
src/DatasetAPI/Datasets.jl 26 75.57%
Totals Coverage Status
Change from base Build 9851163720: -0.9%
Covered Lines: 1196
Relevant Lines: 1772

💛 - Coveralls

@coveralls
Copy link

coveralls commented Jul 22, 2024

Pull Request Test Coverage Report for Build 9907774908

Details

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 68.379%

Totals Coverage Status
Change from base Build 9851163720: 0.0%
Covered Lines: 1211
Relevant Lines: 1771

💛 - Coveralls

@aasdelat
Copy link
Contributor Author

aasdelat commented Jul 23, 2024

Ok @coveralls , I will fix it.

Eliminated explicit output blocks. Added information about subsetting when the data is not loaded into memory.
docs/src/UserGuide/faq.md Outdated Show resolved Hide resolved
docs/src/UserGuide/faq.md Outdated Show resolved Hide resolved
docs/src/UserGuide/faq.md Outdated Show resolved Hide resolved
docs/src/UserGuide/faq.md Outdated Show resolved Hide resolved
docs/src/UserGuide/faq.md Outdated Show resolved Hide resolved
Copy link
Collaborator

@lazarusA lazarusA left a comment

Choose a reason for hiding this comment

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

You can incorporate the suggested changes (if you agree) by clicking the button commit suggestion. Thanks for the PR.

aasdelat and others added 7 commits July 24, 2024 09:23
Take into account that a Cube is no more than a YAXArray. So, the explicit section about Cubes has been deleted.
I have deleted a comment in the code exaple because I do not understand it.
docs/src/UserGuide/faq.md Outdated Show resolved Hide resolved
@lazarusA lazarusA merged commit 1538399 into JuliaDataCubes:master Jul 27, 2024
6 of 11 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.

3 participants