Repository navigation
feat: add raw desc fields - #86
Open
OulipianSummer wants to merge 1 commit into
Open
OulipianSummer wants to merge 1 commit into
OulipianSummer wants to merge 1 commit into
Conversation
OulipianSummer
force-pushed
the
raw_desc
branch
from
November 20, 2026 02:32
54d74de to
9b979b6
Compare
OulipianSummer
marked this pull request as ready for review
November 20, 2026 02:33
This branch has not been deployed
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 PR introduces a new field for classes and functions called
raw_desc. It is a raw, unprocessed, unparsed version of the docblock before the parser has touched it. This can be a useful target for custom theme support where you can reference the original docblock and pull any content out of it using whatever mothod you like without having to fight the internal parser first.This can be a nice alternative to the
longDescfield, especially if your documentation uses a lot of inline tags inside of text, which currently break the parser. See: #81. The linked issue will likely need a little extra help in order to get resolved, but this is a nice first step.Sample output:
This addresses: #82