Skip to content

DOCS: complete docstrings and documentation#1

Merged
anmorgunov merged 2 commits intomasterfrom
docs/update-readmes
Feb 14, 2025
Merged

DOCS: complete docstrings and documentation#1
anmorgunov merged 2 commits intomasterfrom
docs/update-readmes

Conversation

@anmorgunov
Copy link
Copy Markdown
Contributor

📝 Initial Project Setup

Overview

This PR establishes the foundational structure for the Batista Template project, setting up essential documentation, configuration files, and core module examples.

Changes

  • updated READMEs
  • added docstrings to all functions and added blocks to display source code in docs folder
  • added docs customization stylesheets

@anmorgunov anmorgunov requested a review from randyshee February 14, 2025 20:41
Copy link
Copy Markdown
Collaborator

@randyshee randyshee left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

Some comments:

  1. perhaps talk about typedict and dataclass (comparison)
  2. can add multi-case pytest best practice

@anmorgunov anmorgunov merged commit f3d557d into master Feb 14, 2025
@anmorgunov anmorgunov deleted the docs/update-readmes branch February 14, 2025 21:05
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

Successfully merging this pull request may close these issues.

2 participants