Open Issues Need Help
View All on GitHubAI Summary: This issue tasks developers with reviewing all functions in the codebase to enhance their clarity and documentation. The goal is to ensure each function has a well-defined signature, including type hints for parameters and return values, and a comprehensive docstring. Docstrings should detail the function's purpose, input/output types, side effects, and any exceptions to improve code readability and maintainability.
A Python package for generating PDF codebooks from tabular data. Quickly create project descriptions, data dictionaries, and variable summaries with customizable formatting. Ideal for data science, reproducible research, and sharing dataset documentation.
AI Summary: This GitHub issue provides a beginner's guide on how to run `pytest` locally before creating a pull request. It explains the purpose of `pytest` and virtual environments, then offers step-by-step instructions starting with creating a virtual environment in the project folder.
A Python package for generating PDF codebooks from tabular data. Quickly create project descriptions, data dictionaries, and variable summaries with customizable formatting. Ideal for data science, reproducible research, and sharing dataset documentation.