Skip to content

Commit

Permalink
Refactor SeqInfo class (#63)
Browse files Browse the repository at this point in the history
- Update the necessary validation functions to accept numpy vectors
- Added pretty print methods
- Added subset method
- Update tests and docstrings
  • Loading branch information
jkanche authored Jan 21, 2024
1 parent 71529f3 commit cc72493
Show file tree
Hide file tree
Showing 3 changed files with 432 additions and 96 deletions.
8 changes: 7 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
# Changelog

## Version 0.4.0 to 0.4.5
## Version 0.4.9

Bring `SeqInfo` upto speed with the rest of the class implementations. Added subset and pretty print functionality.

## Version 0.4.0 to 0.4.8

This is a complete rewrite of both these classes following the functional paradigm from our [developer notes](https://github.com/BiocPy/developer_guide#use-functional-discipline).

Expand All @@ -13,6 +17,7 @@ Most range based methods have been reimplemented and the heavy lifting is done i
Tests, documentation and readme has been updated to reflect these changes.

## Version 0.3.0

This release migrates the package to a more palatable Google's Python style guide. A major modification to the package is with casing, all `camelCase` methods, functions and parameters are now `snake_case`.

In addition, docstrings and documentation has been updated to use sphinx's features of linking objects to their types. Sphinx now also documents private and special dunder methods (e.g. `__getitem__`, `__copy__` etc). Intersphinx has been updated to link to references from dependent packages.
Expand All @@ -22,6 +27,7 @@ Configuration for flake8, ruff and black has been added to pyproject.toml and se
Finally, pyscaffold has been updated to use "myst-parser" as the markdown compiler instead of recommonmark. As part of the pyscaffold setup, one may use pre-commits to run some of the routine tasks of linting and formatting before every commit. While this is sometimes annoying and can be ignored with `--no-verify`, it brings some consistency to the code base.

## Version 0.2

- Now uses BiocFrame as the underlying class
- Implement interval based operations
- update documentation, readme
Expand Down
Loading

0 comments on commit cc72493

Please sign in to comment.