Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Breaking changes to do #11

Closed
9 of 10 tasks
lpatiny opened this issue Feb 8, 2024 · 0 comments · Fixed by #12
Closed
9 of 10 tasks

Breaking changes to do #11

lpatiny opened this issue Feb 8, 2024 · 0 comments · Fixed by #12
Assignees
@jobo322

Comments

@lpatiny
Copy link
Member

lpatiny commented Feb 8, 2024 •
edited by jobo322
Loading

  • expose only 2 methods: treeSimilarity(tree, tree, options) and createTree (remove getFunction)
  • rename internal method getSimilarity to treeSimilarity (same for test)
  • export directly the new treeSimilarity from index.js (no wrap in another function)
  • treeSimilarity do not accepts Array of Array (only Tree)
  • remove Tree class
  • add jsdoc type for Tree
  • add correct jsdoc for the methods
  • add more testcases
  • createTree should only accept {x:[], y:[]} where x and y are NumberArray (from cheminto-types)
  • Adapt the README.md
@jobo322 jobo322 linked a pull request Feb 8, 2024 that will close this issue
refactor: change exposed methods and accepted types #12
Merged
@targos targos closed this as completed in #12 Feb 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@jobo322 jobo322

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

refactor: change exposed methods and accepted types mljs/tree-similarity
2 participants
@lpatiny @jobo322