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.

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

Improve errors reporting and documentation #60

Open
2 tasks
maclandrol opened this issue Jun 15, 2023 · 0 comments
Open
2 tasks

Improve errors reporting and documentation #60

maclandrol opened this issue Jun 15, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@maclandrol
Copy link
Member

This was reported by César Miguel in the slack channel:

I don't have any particular notions as of now, but simply a descriptive error message hinting at the way 
FeatConcat/MoleculeTransformer etc interact as opposed to the current "Cannot transform molecule..."
would probably be a great starting point. 
...
Maybe just writing the logic behind the use of each of these and/or their intended use 
cases/best practices beyond the current "base case" functionalities somewhere in the docs? 

Proposed actions:

  • a quick table that explains and summarize what each of the Transformer classes do differently to help guide users.
  • forwarding deeper level exception to the users
@maclandrol maclandrol added documentation Improvements or additions to documentation enhancement New feature or request labels Jun 15, 2023
@maclandrol maclandrol mentioned this issue Jul 20, 2023
Merged
5 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant