Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Rename api.py

See original GitHub issue

The API is not just in api.py anymore so we should rename it to dataset.py or similar.

Issue Analytics

State:
Created 3 years ago
Comments:7 (1 by maintainers)

Top GitHub Comments

1reaction

eric-czechcommented, Aug 10, 2020

I tend to prefer keeping the public API as flat as possible, and regard the internal file structure as a private implementation detail.

👍

The only public function that I know of that is not currently at the top-level is testing.simulate_genotype_call_dataset

I think this function (or something like it) is key for a lot of documentation. Being able to play with the parameters for the dimensions that get created as well as missingness will be an important part of the Xarray learning process. It does seem a little peculiar for it to come out of a testing module though if we’re going to use it widely. Perhaps it should be in a datasets.py module instead, which also contains code for fetching public or other static test datasets?

0reactions

tomwhitecommented, Sep 7, 2020

The internal organisation is orthogonal to the public API, so this issue shouldn’t hold up docs. Having said that, I think this issue is just a simple rename. In https://github.com/pystatgen/sgkit/pull/236, I have renamed to model.py, as suggested in this issue - and also echoing scikit-allel.