Docs quality pass: clarify core how-to flows with concrete expected outputs#1298
Merged
Docs quality pass: clarify core how-to flows with concrete expected outputs#1298
Conversation
Agent-Logs-Url: https://github.com/SkBlaz/py3plex/sessions/2f321f43-cfd8-4b92-b9e0-2d00a58627db Co-authored-by: SkBlaz <10035780+SkBlaz@users.noreply.github.com>
Agent-Logs-Url: https://github.com/SkBlaz/py3plex/sessions/2f321f43-cfd8-4b92-b9e0-2d00a58627db Co-authored-by: SkBlaz <10035780+SkBlaz@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Update documentation for clarity and examples
Docs quality pass: clarify core how-to flows with concrete expected outputs
Mar 26, 2026
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
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.
This pass tightens user-facing docs where examples were ambiguous or lacked concrete verification output. It focuses on high-traffic RST guides and adds explicit, copy-paste-friendly patterns for common workflows.
Load/build network docs: remove ambiguity in construction paths
docfiles/how-to/load_and_build_networks.rstto make Method 2/3 clearer and verifiable.basic_stats()checkpoints and expected output blocks so users can immediately validate shape/count assumptions.DSL querying docs: make multilayer semantics concrete
docfiles/how-to/query_with_dsl.rstwith a concretelayer_countexample and expected output.dictvalues withmean/std/quantiles) instead of generic prose.Quickstart tutorial: improve first-run signal
docfiles/getting_started/tutorial_10min.rstExample 1 to show focused output (id,degree_centrality) and an illustrative expected output block.Guardrail tests for doc quality regression
tests/test_docs_quality_pass.pyto lock in these documentation guarantees:layer_countexplanation remains concrete,🔒 GitHub Advanced Security automatically protects Copilot coding agent pull requests. You can protect all pull requests by enabling Advanced Security for your repositories. Learn more about Advanced Security.