G-Node / G-Node/nixpy

Documentation updates

Open
#448 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
22
Forks
29
PR merge metrics
No merged PRs in 30d

Description

Update the docs with new tutorials and advanced topics:
- [ ] Add DataFrame creation and usage to tutorials section.
- [ ] Create advanced section of tutorial
- [ ] Describe usage of Compression.
- [ ] Describe chunking, how it's affected by object creation (size, initial data), how it affects file sizes, and writing and reading performance.
- [ ] Add description of new Tag and MultiTag flexible dimensions.
- [ ] Add description of new MultiTag data creation.
- [ ] Update tutorials with new Tag method names (`tagged_data()`, `feature_data()`).

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by locating the tutorials documentation and reviewing its existing structure, then check the current APIs for DataFrame creation, Compression, chunking, Tag, and MultiTag. Update the tutorials and add the advanced section so every checklist item is covered, including the renamed tag methods and the requested performance and file-size explanations.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.