Regenerate docs/api.md - #2688
Merged
Merged
Conversation
docs/api.md was out of date relative to current source code YARD comments. Regenerate it via `rake docs:build`. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
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
1 participant
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.
What?
docs/api.mdwas out of date compared to the current source's YARD documentation comments.Why?
Keep generated API docs in sync with the codebase.
How?
Ran
rake docs:buildto regeneratedocs/api.md. Changes reflect added methods (after_compile,around_render,format,initialize,vc_test_view_context), a removed/changed method (newdocs removed,render_insignature updated to**), and a removed outdated note aboutrendered_preview.