Skip to content

docs: Update IAVSRegistar in docs/core/AllocationManager.md #1305

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

HudsonGraeme
Copy link

Motivation:

The IAVSRegistrar interface has diverged from the documented interface within docs/core/AllocationManager.md. While implementing IAVSRegistrar following the document, this divergence was discovered. The goal of this PR is to address the divergence by bringing the relevant document up to date with the code implementation.

Modifications:

The docs/core/AllocationManager.md file is updated to correctly reflect the current state of IAVSRegistrar.

Result:

The documentation for AllocationManager.md now reflects the current implementation of IAVSRegistrar.

@HudsonGraeme HudsonGraeme changed the title docs: Improve allocation manager docs docs: Update IAVSRegistar in docs/core/AllocationManager.md Apr 7, 2025
@HudsonGraeme
Copy link
Author

A minor thought here too, to reduce future efforts needed to keep docs in sync with code changes. It may prudent to consider only linking to the relevant code sections, rather than including the code blocks themselves within the docs.

@non-fungible-nelson
Copy link
Contributor

@MadelineAu - for consideration and merging into repo

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