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

Add separate, more detailed section for the Input Writer? #254

Open
wilhadams opened this issue Apr 1, 2021 · 1 comment
Open

Add separate, more detailed section for the Input Writer? #254

wilhadams opened this issue Apr 1, 2021 · 1 comment

Comments

@wilhadams
Copy link
Collaborator

Adding things like non-standard basis set options (#221) are making it possible to do a lot of useful and complex things with the input writer, which is really exciting. However, when I was previously adding examples for using custom templates, I started to worry that the "Input Files" section of the getting started page was beginning to get pretty lengthy. Would it make sense to break out most of the input writer details into a new page, and leave just the basic usage in the getting started page?

@tovrstra @FarnazH @PaulWAyers

@tovrstra
Copy link
Member

tovrstra commented Apr 1, 2021

Yes, most definitely. It would be good to have a separate section with more elaborate examples, while keeping the "Getting Started" is kept short and simple.

While doing this, it could be good to address #210 too. Executing the more elaborate examples int the unit tests would guarantee the examples keep working. (This also implies the necessary input files are present to run the examples, which would also be helpful.)

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

No branches or pull requests

2 participants