[Data][Docs] Split Input/Output API reference into Loading and Saving Data APIs #59918
Conversation
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request effectively reorganizes the Data Input/Output API documentation by splitting it into two more focused pages: 'Loading Data API' and 'Saving Data API'. This is a great improvement for organization and usability, mirroring the structure of the user guides. The changes are well-implemented, including the renaming of files, creation of the new saving_data.rst file, and updating all references throughout the documentation. I've found one minor formatting issue that goes against the stated goal of standardizing section headers, which I've commented on. Overall, this is a solid contribution to improving the documentation.
doc/source/data/api/loading_data.rst
Outdated
|
|
||
| MongoDB | ||
| ------- | ||
| ------ |
There was a problem hiding this comment.
The underline for the MongoDB section header is one character short. It should have the same length as the title "MongoDB" (7 characters). Since the PR description mentions standardizing header formatting, this should be corrected for consistency.
| ------ | |
| ------- |
… Data APIs (ray-project#59301) Split the Input/Output API reference page into two separate pages: - Loading Data API (loading_data.rst) - contains all read/from APIs - Saving Data API (saving_data.rst) - contains all write/to APIs This improves organization and mirrors the structure of the user guides which already split loading and saving into separate pages. Changes: - Renamed input_output.rst to loading_data.rst - Created saving_data.rst with all saving/writing APIs - Updated api.rst to reference both new files - Updated all references from input-output to loading-data-api/saving-data-api - Standardized section header formatting with dashes matching title length Signed-off-by: mgchoi239 <mg.choi.239@gmail.com>
mgchoi239
force-pushed
the
doc/split-input-output-api
branch
from
06814bd to
a723436
Compare
ray-gardener
bot
added
docs
bveeramani
left a comment
bveeramani
left a comment
There was a problem hiding this comment.
LGTM except the three section. I'll move since it's a small change
Signed-off-by: Balaji Veeramani <bveeramani@berkeley.edu>
|
@mgchoi239 as a follow-up, would you be interested in alphabetially sorting the APIs in the loading and saving references? I know it's pretty rote, but I think it'll make a meaningful impact in improving the readability of our reference |
|
Yeah that will definitely improve readability, Ill share a PR once it's ready. Wonder if there's other levels of granularity to take account of (e.g having proprietary APIs above customized ones) |
… Data APIs (ray-project#59918) This PR splits the Input/Output API reference page into two separate pages to improve organization and mirror the structure of the user guides. ## Changes - Renamed `input_output.rst` to `loading_data.rst` - Created `saving_data.rst` with all saving/writing APIs - Updated `api.rst` to reference both new files - Updated all references from `input-output` to `loading-data-api`/`saving-data-api` - Standardized section header formatting with dashes matching title length Fixes ray-project#59301 --------- Signed-off-by: mgchoi239 <mg.choi.239@gmail.com> Signed-off-by: Balaji Veeramani <bveeramani@berkeley.edu> Co-authored-by: mgchoi239 <mg.choi.239@gmail.com> Co-authored-by: Balaji Veeramani <bveeramani@berkeley.edu> Signed-off-by: jasonwrwang <jasonwrwang@tencent.com>
2 participants
This PR splits the Input/Output API reference page into two separate pages to improve organization and mirror the structure of the user guides.
Changes
input_output.rsttoloading_data.rstsaving_data.rstwith all saving/writing APIsapi.rstto reference both new filesinput-outputtoloading-data-api/saving-data-apiFixes #59301