docs: fix msgParsator literal block in parsing#1399
Open
jaelliot wants to merge 1 commit intoWebOfTrust:mainfrom
Open
docs: fix msgParsator literal block in parsing#1399jaelliot wants to merge 1 commit intoWebOfTrust:mainfrom
jaelliot wants to merge 1 commit intoWebOfTrust:mainfrom
Conversation
One-file docstring-only salvage on branch from upstream/main. Changes in src/keri/core/parsing.py: - mark msgParsator Logic section as literal block (Logic:: + blank line) - quote type-like text in Parser docs to avoid unresolved references (Verfifier, Versionage) Validation: - pre-edit parsing.py warning lines: 3 - msgParsator: Unexpected indentation - msgParsator: Definition list ends without blank line - Parser: py:class reference target not found (Verfifier) - post-edit parsing.py warning lines: 0 - compare_test_baseline.py: no new failures introduced - check_doc_changes.py: exit 0
jaelliot
force-pushed
the
chore/docstrings-parsing-only
branch
from
503f202 to
098cc96
Compare
Contributor
Author
|
Follow-up update pushed to the PR branch. New head: What changed:
Validation rerun locally:
No functional code changes. |
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.
Summary
This PR fixes the
Parser.msgParsatordocstring insrc/keri/core/parsing.pyby marking the indented pseudo-code block as a proper literal block.Scope
src/keri/core/parsing.pyWhy
The Sphinx/docutils warning source for this lane was:
docstring of keri.core.parsing.Parser.msgParsator:44: ERROR: Unexpected indentation. [docutils]docstring of keri.core.parsing.Parser.msgParsator:47: WARNING: Definition list ends without a blank line; unexpected unindent. [docutils]The fix preserves the existing wording and only changes the docstring structure so the pseudo-code block parses correctly.
Validation
parsing.pywarning lines no longer appearcompare_test_baseline.pyreported no new failures introduced by this changeNotes
This branch was pushed using the updated local guardrail path for structurally docstring-only Python changes, so unrelated Ruff and pytest blockers in the file or environment no longer block a docstring-only commit/push.