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

Refactor and Simplify Documentation #395

Merged
merged 10 commits into from
May 23, 2024

Conversation

danlooo
Copy link
Member

@danlooo danlooo commented May 22, 2024

This PR aims to make the documentation more readable and consistent. Everything from the old documentation is migrated to here if they are not redundant.

  • One page per task, e.g. read or write. Group all file formats into one page
  • Add explanation about the data types, e.g. Array vs Cube
  • Add page on how to convert between other types: e.g. Raster
  • Add example on how to read ArchGDAL
  • Add example on mapCube that modifies input and output dimensions (i.e. lat and lon to region)
  • Consistent naming of arrays and datasets
  • Simplify get started: Only 2 lines of code to the first YAXArray

Please feel free to comment on further improvements to make this package as easy to use as possible.

@coveralls
Copy link

coveralls commented May 22, 2024

Pull Request Test Coverage Report for Build 9209944563

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.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 68.231%

Totals Coverage Status
Change from base Build 8923844786: 0.0%
Covered Lines: 1207
Relevant Lines: 1769

💛 - Coveralls

Copy link

codecov bot commented May 22, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 68.15%. Comparing base (a287107) to head (778f635).
Report is 3 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master     #395   +/-   ##
=======================================
  Coverage   68.15%   68.15%           
=======================================
  Files          12       12           
  Lines        1771     1771           
=======================================
  Hits         1207     1207           
  Misses        564      564           

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

@lazarusA
Copy link
Collaborator

lazarusA commented May 22, 2024

the etc folder needs a better name. Remember, the file structure will gives the actual final path to the resource. Hence, descriptive names are preferred.
Edit: ohh, it looks like a temporal edit TODO.

@danlooo
Copy link
Member Author

danlooo commented May 22, 2024

That's right. Its my working dir for stuff that is not integrated yet. I'll yet you know once this draft PR is ready

@danlooo danlooo changed the title Refactor Documentation Refactor and Simplify Documentation May 23, 2024
@danlooo danlooo marked this pull request as ready for review May 23, 2024 14:18
@danlooo
Copy link
Member Author

danlooo commented May 23, 2024

I'm done for my side with migrating the entire documentation to a consistent structure. Fell free to comment and merge @meggart @lazarusA @felixcremer

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.

Great job.

@lazarusA lazarusA merged commit 7a80fe5 into JuliaDataCubes:master May 23, 2024
10 of 11 checks passed
@danlooo danlooo deleted the refactor_documentation branch May 23, 2024 14:54
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