Skip to content

[pyos][docs] to_awkward and from_awkward undocumented #436

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.

Sign up for GitHub

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

Jump to bottom
Closed
sneakers-the-rat opened this issue Apr 17, 2023 · 0 comments · Fixed by #457
Closed

[pyos][docs] to_awkward and from_awkward undocumented #436

sneakers-the-rat opened this issue Apr 17, 2023 · 0 comments · Fixed by #457
Labels
documentation Improve or add to documentation

Comments

@sneakers-the-rat
Copy link

The functions to_awkward and from_awkward are undocumented:

+1 for using automodule and splitting i/o module up in package and submodules with module-level docstrings so you don't have to worry about this in the future and just have docs in one place.

Part of: pyOpenSci/software-submission#81
@sneakers-the-rat sneakers-the-rat mentioned this issue Apr 17, 2023
Closed
24 tasks
@eriknw eriknw added the documentation Improve or add to documentation label Apr 18, 2023
SultanOrazbayev added a commit to SultanOrazbayev/python-graphblas that referenced this issue Apr 19, 2023
@SultanOrazbayev
Update io.rst
528f13f 
As raised in python-graphblas#436
@SultanOrazbayev SultanOrazbayev mentioned this issue Apr 19, 2023
Closed
@jim22k jim22k linked a pull request Apr 22, 2023 that will close this issue
Update io.rst #443
Closed
@eriknw eriknw mentioned this issue Apr 26, 2023
Merged
@SultanOrazbayev SultanOrazbayev mentioned this issue Jun 2, 2023
Merged
jim22k pushed a commit that referenced this issue Jul 5, 2023
@SultanOrazbayev
doc: update io.rst for awkward array (#457)
79cf3fa 
* Update io.rst

As raised in #436

* Update documentation for `awkward-array`-related io functions.

* Update the doc string and change the order of the functions to reflect their intended use case.

remove trailing blanks

* Use double backticks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improve or add to documentation
Projects
None yet
Milestone
No milestone
2 participants
@eriknw @sneakers-the-rat