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.

Sign up for GitHub

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

Jump to bottom

Better documentation of Simulator #97

Open
picciama opened this issue Nov 20, 2019 · 0 comments
Open

Better documentation of Simulator #97

picciama opened this issue Nov 20, 2019 · 0 comments
Assignees
@ilan-gold
Labels
documentation Improvements or additions to documentation

Comments

@picciama
Copy link
Collaborator

batchglm/models/base_glm/simulator/Simulator has a property self.sample_description along with other properties that are not that visible since they are assigned within methods and are not explained via docstrings.
We should there provide better documentation here:

batchglm/batchglm/models/base_glm/simulator.py

Line 85 in 2348481

self.sim_design_loc, self.sample_description = generate_sample_description(

@picciama picciama added the documentation Improvements or additions to documentation label Nov 20, 2019
@picciama picciama assigned ilan-gold and unassigned davidsebfischer Mar 7, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@ilan-gold ilan-gold

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@davidsebfischer @ilan-gold @picciama