Add comprehensive docstrings to DataProduct methods#253
Open
datatools-agent-jul2026 wants to merge 1 commit into
Open
Add comprehensive docstrings to DataProduct methods#253datatools-agent-jul2026 wants to merge 1 commit into
datatools-agent-jul2026 wants to merge 1 commit into
Conversation
Add Google-style docstrings for __init__, load_all(), plot_graph(), and plot_sources_graph() to improve API documentation and IDE support. Fixes Intugle#128
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds Google-style docstrings to four undocumented methods in the
DataProductclass:__init__()load_all()plot_graph()plot_sources_graph()These docstrings follow the same style as existing methods like
plan(),build(), andgenerate_query(), and include Args, Examples, and Notes sections where appropriate.Testing
ruff check src/intugle/data_product.py— passespytest tests/query_generator/test_query_generator.py tests/adapters/test_sql_identifier_safety.py6/6 passedFixes [GOOD FIRST ISSUE] Add Docstrings to DataProduct Class Methods #128