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

Misc #70

Merged
merged 8 commits into from
Jul 25, 2023
Merged

Misc #70

merged 8 commits into from
Jul 25, 2023

Conversation

maclandrol
Copy link
Member

Changelogs

  • Improve documentation with some explanation and best practices
  • Fix issues in docs highlighting.

Checklist:

  • Was this PR discussed in an issue? It is recommended to first discuss a new feature into a GitHub issue before opening a PR.
  • Add tests to cover the fixed bug(s) or the new introduced feature(s) (if appropriate).
  • Update the API documentation if a new function is added, or an existing one is deleted. Eventually consider making a new tutorial for new features.
  • Write concise and explanatory changelogs below.
  • If possible, assign one of the following labels to the PR: feature, fix or test (or ask a maintainer to do it for you).

This PR addresses #60 and #69

@maclandrol maclandrol requested a review from cwognum July 21, 2023 02:05
Copy link
Collaborator

@hadim hadim left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I found the FAQ to be excellent.

Given how much information is given in the FAQ, maybe it would be worth having a dedicated section (or more than one) on the usage.md page or another one covering the basics design concepts of molfeat? Those would be based on the various questions in the FAQ (and probably make the FAQ shorter).

It's just a proposal since I found the FAQ to already be super informative without more changes.

@maclandrol
Copy link
Member Author

I found the FAQ to be excellent.

Given how much information is given in the FAQ, maybe it would be worth having a dedicated section (or more than one) on the usage.md page or another one covering the basics design concepts of molfeat? Those would be based on the various questions in the FAQ (and probably make the FAQ shorter).

It's just a proposal since I found the FAQ to already be super informative without more changes.

Good idea, I will open another issue for that. Might make sense to systematically write a design/concepts doc for all packages

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants