docs: document ALGORITHM option and wire it into Docker#9
Merged
Conversation
The --algorithm bfs|bestfirst|astar flag was only reachable via the CLI; the Docker entrypoint (the documented interface) had no way to select it. Add an ALGORITHM env var mapped to --algorithm in docker-compose.yml and the graph entrypoint, and document the three search strategies in the README. WITH_DFS=true continues to take precedence.
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.
Summary
Follow-up to #8. The
--algorithm bfs|bestfirst|astarflag added there was only reachable via the CLI — the Docker entrypoint (the interface the README documents) had no way to select it, so the README didn't reflect the new search strategies.Changes
ALGORITHMenv var (defaultbfs) todocker-compose.ymland map it to--algorithmindocker/Dockerfile.graph's entrypoint, mirroring howWITH_DFS/BFS_MAX_DEPTH/BFS_TIMEOUT_Sare wired.bfs,bestfirst,astar) in the README, and note thatWITH_DFS=truetakes precedence.Testing
Verified the entrypoint's generated flag combinations parse and run:
--algorithm astar,--with-dfs --algorithm bestfirst(DFS path wins, as documented), and the unset default (bfs).