docs: clarify what the package provides - #366
Open
henryiii wants to merge 2 commits into
Open
Conversation
State that the package does not provide Python bindings to the ninja build engine, only the executable and upstream ninja_syntax.py, and that contributions are welcome. Document ninja.ninja() and ninja.BIN_DIR, and fix two typos. Closes #38 Assisted-by: ClaudeCode:claude-opus-5
henryiii
commented
Sep 1, 2026
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.
🤖 AI text below 🤖
The README now says that the package does not provide Python bindings to the ninja build engine. It only distributes the executable and the upstream
ninja_syntax.pyhelper, and contributions that add bindings are welcome.Also documents the public
ninja.ninja()andninja.BIN_DIR, and fixes two typos ("accesable", "nijnja").Closes #38