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

DOC: Split up the IO docs #60825

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open

DOC: Split up the IO docs #60825

wants to merge 6 commits into from

Conversation

cobaltt7
Copy link
Contributor

@cobaltt7 cobaltt7 commented Feb 2, 2025

@cobaltt7
Copy link
Contributor Author

Hi, bumping this... @mroeschke could this be looked at soon?

@rhshadrach
Copy link
Member

@cobaltt7 - the docs build is failing. This will need to be addressed.

Copy link
Member

@mroeschke mroeschke left a comment

Choose a reason for hiding this comment

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

May I suggest before splitting the IO docs possibly consolidating some information first (i.e. moving information to other locations)? e.g.

  1. Remove sections that just repeat parameters that are in the docstrings.
  2. For small sections that just show an example, move that example to the Example section in the appropriate docstring

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.

DOC: splitting the IO docs into separate pages
3 participants