Repository navigation
docs: fix runnable onboarding examples and commands - #432
Open
dajiaohuang wants to merge 1 commit into
Open
dajiaohuang wants to merge 1 commit into
dajiaohuang wants to merge 1 commit into
Conversation
This branch has not been deployed
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
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.
Problem
The installation page's
mytest.pyand the README's Python example still use Python 2printstatements. Copying either example into Python 3 fails withSyntaxErrorbefore the example can run. The installation page also names the Ubuntu packagebuild-essentials(the package isbuild-essential) and instructs users to runcondatest.sh, which is no longer in the repository.The design guide additionally calls a nonexistent
BedTool.intersectBedmethod and usesmergerather than the BEDToolsmergeBedalias in its shell pipeline. Its statement that every BedTool must point to a file contradicts the documentedstream=Trueinterface.Changes
print(...)in the two runnable onboarding examples.condatest.shsubsection, retaining the existing unit/doctest instructions.No runtime code or generated documentation is changed.
Validation
efb8534c11ca6b45a6cd173ff3b3d1bf754e34a1in an isolated Python 3.12.3 environment on Ubuntu 24.04, using Cython 3.3.0 and bedtools 2.31.1.a.bed/b.bedfixtures.BedToolconstruction, coordinate/strand mutation, intersect/sort/merge, streaming/iterator consumption, saving and isolated temporary-file cleanup against real bedtools. The corrected shell pipeline matches the chained Python API result.build-essential, and the repository tree has nocondatest.sh.git diff --checkpassed.The complete test suite, Sphinx site build and older Python/bedtools version matrix were not run. No external genomic data or chromosome-size downloads were used.