Skip to content

Adds autogenerated documentation / tests#1

Merged
redvers merged 4 commits into
mainfrom
initial_docs
Jan 11, 2026
Merged

Adds autogenerated documentation / tests#1
redvers merged 4 commits into
mainfrom
initial_docs

Conversation

@redvers
Copy link
Copy Markdown
Collaborator

@redvers redvers commented Jan 11, 2026

(Which I will eventually need to rewrite to be more indicative of use verses how it is implemented).

(Which I will eventually need to rewrite to be more indicative of
use verses how it is implemented).
@redvers
Copy link
Copy Markdown
Collaborator Author

redvers commented Jan 11, 2026

Hi @redvers,

The changelog - added label was added to this pull request; all PRs with a changelog label need to have release notes included as part of the PR. If you haven't added release notes already, please do.

Release notes are added by creating a uniquely named file in the .release-notes directory. We suggest you call the file 1.md to match the number of this pull request.

The basic format of the release notes (using markdown) should be:

## Title

End user description of changes, why it's important,
problems it solves etc.

If a breaking change, make sure to include 1 or more
examples what code would look like prior to this change
and how to update it to work after this change.

Thanks.

The only corrections I needed to make were:

* ponytest → pony_test
* Correcting the relative library paths
* Correcting the "Count" condition from >= 2.0, to == 2.0
@redvers redvers changed the title Added autogenerated documentation Added autogenerated documentation / tests Jan 11, 2026
@redvers redvers changed the title Added autogenerated documentation / tests Adds autogenerated documentation / tests Jan 11, 2026
@redvers redvers merged commit ccb3de9 into main Jan 11, 2026
7 checks passed
github-actions Bot pushed a commit that referenced this pull request Jan 11, 2026
github-actions Bot pushed a commit that referenced this pull request Jan 11, 2026
redvers added a commit that referenced this pull request Jan 11, 2026
In our previous iteration of this API we had Pony Class instances
freeing C structs which were still referenced by Xml2Doc.

The documentation states that for our current parsing use-cases it
is unsafe to automatically _final() free any of the XmlNodes as they're
a part of our XmlDoc tree.

As such, we have threaded a tag reference through every dependent Pony
instance so that it will be "impossible"™ for Xml2Doc._final() to
execute the frees until all other dependent references are no longer
reachable.
@redvers redvers deleted the initial_docs branch January 11, 2026 08:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant