ragflow/docs
Xinghan Pan 47926f7d21
Improve API Documentation, Standardize Error Handling, and Enhance Comments (#5990)
### What problem does this PR solve?  
- The API documentation lacks detailed error code explanations. Added
error code tables to `python_api_reference.md` and
`http_api_reference.md` to clarify possible error codes and their
meanings.
- Error handling in the codebase is inconsistent. Standardized error
handling logic in `sdk/python/ragflow_sdk/modules/chunk.py`.
- Improved API comments by adding standardized docstrings to enhance
code readability and maintainability.

### Type of change  
- [x] Documentation Update  
- [x] Refactoring
2025-03-13 19:06:50 +08:00
..
develop DOCS: for release. (#6023) 2025-03-13 15:09:29 +08:00
guides Added 0.17.2 release notes (#6028) 2025-03-13 15:59:58 +08:00
references Improve API Documentation, Standardize Error Handling, and Enhance Comments (#5990) 2025-03-13 19:06:50 +08:00
_category_.json Reorganized docs for docusaurus publish (#860) 2024-05-21 20:53:55 +08:00
configurations.md DOCS: for release. (#6023) 2025-03-13 15:09:29 +08:00
faq.md DOCS: for release. (#6023) 2025-03-13 15:09:29 +08:00
quickstart.mdx DOCS: for release. (#6023) 2025-03-13 15:09:29 +08:00
release_notes.md Added 0.17.2 release notes (#6028) 2025-03-13 15:59:58 +08:00