Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Docs quality pass: clarify core how-to flows with concrete expected outputs#1298

Merged
SkBlaz merged 3 commits intomasterSkBlaz/py3plex:masterfrom
copilot/docs-quality-passSkBlaz/py3plex:copilot/docs-quality-passCopy head branch name to clipboard
Mar 26, 2026
Merged

Docs quality pass: clarify core how-to flows with concrete expected outputs#1298
SkBlaz merged 3 commits intomasterSkBlaz/py3plex:masterfrom
copilot/docs-quality-passSkBlaz/py3plex:copilot/docs-quality-passCopy head branch name to clipboard

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Mar 26, 2026

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

    • Updated docfiles/how-to/load_and_build_networks.rst to make Method 2/3 clearer and verifiable.
    • Added explicit basic_stats() checkpoints and expected output blocks so users can immediately validate shape/count assumptions.
  • DSL querying docs: make multilayer semantics concrete

    • Updated docfiles/how-to/query_with_dsl.rst with a concrete layer_count example and expected output.
    • Expanded uncertainty section to show the actual result shape users should expect (dict values with mean/std/quantiles) instead of generic prose.
  • Quickstart tutorial: improve first-run signal

    • Updated docfiles/getting_started/tutorial_10min.rst Example 1 to show focused output (id, degree_centrality) and an illustrative expected output block.
  • Guardrail tests for doc quality regression

    • Added tests/test_docs_quality_pass.py to lock in these documentation guarantees:
      • expected-output sections exist for key creation/query tutorials,
      • multilayer layer_count explanation remains concrete,
      • uncertainty result-shape guidance remains explicit.
# Added as canonical DSL clarity pattern in docs:
layer_specific = Q.nodes().where(layer_count__eq=1).execute(network)
connectors = Q.nodes().where(layer_count__gte=2).execute(network)

print(f"Layer-specific nodes: {len(layer_specific)}")
print(f"Connector nodes: {len(connectors)}")

🔒 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.

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
Copilot AI requested a review from SkBlaz March 26, 2026 17:50
@SkBlaz SkBlaz marked this pull request as ready for review March 26, 2026 19:50
@SkBlaz SkBlaz merged commit ed458b6 into master Mar 26, 2026
33 checks passed
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.

2 participants

Morty Proxy This is a proxified and sanitized view of the page, visit original site.