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

Unskip doctests in Quick Start guide #266

Open
wtbarnes opened this issue Feb 16, 2024 · 0 comments
Open

Unskip doctests in Quick Start guide #266

wtbarnes opened this issue Feb 16, 2024 · 0 comments

Comments

@wtbarnes
Copy link
Owner

#259 reorganized the docs to add a quick start guide which includes some code snippets. However, these have proved difficult to test because of the need to set up the database beforehand.

One method is of course to build the database in a custom location (a temp file) and then pass that path each time you instantiate that ion but ideally this level of detail is not included in the quick start guide. Instead, we want the default values to be used, with the problem being that the default values are dependent on the RC file and those can change based on how a user has configured their RC file.

Somehow, we need to isolate the creation of an RC file (or really just the defaults), have that be set up when the tests are run, and then torn down when the tests are finished. Ideally, all of the tests would then target this same database and we wouldn't have to worry about configuring this many different ways. This would mean a pretty significant overhaul of how the test database is handled now since currently it is just a fixture explicitly passed around to every test that needs it.

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

No branches or pull requests

1 participant