Document Resource and Session.Store public API - #152
Open
tfwright wants to merge 1 commit into
Open
Conversation
Add @doc to every public function in LiveAdmin.Resource, treating them as stable 1.0 API, and describe the config-override behavior (query_with/render_with/create_with/etc.) each one honors. Add a @moduledoc to the LiveAdmin.Session.Store behaviour and @doc to its callbacks so custom session-store authors have a documented contract, and document LiveAdmin.Session.Agent as the default in-memory implementation.
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
Adds documentation coverage ahead of the 1.0 release:
@docon every public function inLiveAdmin.Resource(all/4,find/5,find!/5,list/5,change/4,create/5,update/5,delete/5,validate/4,fields/2,query/3,render/6,render/2), documenting them as stable 1.0 API and describing the config-override behavior (query_with/render_with/create_with/etc.) each honors.@moduledocon theLiveAdmin.Session.Storebehaviour plus@docon each callback, giving custom session-store authors a documented contract.@moduledoconLiveAdmin.Session.Agentdescribing it as the default in-memory store and its ephemeral semantics.No behavior changes — documentation only.
Verification
mix compile --warnings-as-errorsclean,mix formatcleanmix test— 45 tests, 0 failuresmix docsproduces no broken-reference warnings from these additions🤖 Generated with Claude Code