llnl / llnl/conduit

better doc python interface differences vs cpp, or create more examples

Open
#466 1 comment 0 reactions 0 assignees View on GitHub
docs
Dominant language
C++
Stars
248
Forks
72
Avg merge
1d 16h
Merged PRs (30d)
15

Description

A few cases:

Arg order in relay funcs isn't same as C++, tell folks to prefer named args in python

relay.io.load(node=n,path=p)

leave array vs leaf node acces:

n.fetch("child") vs n["child"] when child is a leaf

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by reviewing the Python interface documentation and examples around relay.io.load, n.fetch("child"), and n["child"], comparing them with the C++ API behavior. Document the argument-order difference and recommend named arguments in Python, then clarify leaf-node access with examples. Done means these differences and examples are covered clearly.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp, python
Domain
api, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.