Skip to content

Manually refresh Quarto docs & revert workflow experiment#435

Merged
nrichers merged 2 commits intomainfrom
manually-refresh-Quarto-docs
Oct 15, 2025
Merged

Manually refresh Quarto docs & revert workflow experiment#435
nrichers merged 2 commits intomainfrom
manually-refresh-Quarto-docs

Conversation

@nrichers
Copy link
Collaborator

@nrichers nrichers commented Oct 11, 2025

Pull Request Description

What and why?

With our Quarto workflows currently blocked by new branch protection rules, this PR:

How to test

What needs special review?

Dependencies, breaking changes, and deployment notes

Release notes

Checklist

  • What and why
  • Screenshots or videos (Frontend)
  • How to test
  • What needs special review
  • Dependencies, breaking changes, and deployment notes
  • Labels applied
  • PR linked to Shortcut
  • Unit tests added (Backend)
  • Tested locally
  • Documentation updated (if required)
  • Environment variable additions/changes documented (if required)

@nrichers nrichers added the internal Not to be externalized in the release notes label Oct 11, 2025
@CLAassistant
Copy link

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

@github-actions
Copy link
Contributor

PR Summary

This pull request introduces extensive documentation enhancements across multiple Quarto (QMD) files related to test suite execution, model validation, prompt validation, and statsmodels integrations. The primary changes include:

  • The addition of return type annotations to a large number of function signatures for enhanced clarity and support of static type checking. For example, functions in the areas of regression metrics, classification evaluation, clustering metrics, and NLP scorers have been updated.

  • Minor formatting updates have been applied in documentation strings to standardize list notation (e.g., using standard list brackets rather than escaped markdown).

  • Updates in docstring documentation for methods such as assign_predictions and new helper methods like set_metric have been added or refined.

These changes aim to improve the overall readability, maintainability, and consistency of the codebase documentation, ensuring that both the technical and descriptive aspects of the test suite and evaluation modules remain clear to developers and users.

Test Suggestions

  • Run the entire test suite to ensure that the newly added type annotations do not affect runtime behavior.
  • Use static analysis tools (e.g., mypy, pylint) to verify that all type hints are correctly formatted and that they integrate smoothly with the codebase.
  • Render the Quarto documentation to confirm that formatting—including any new list notations and docstrings—appears as expected.
  • Compare outputs from functions before and after the change to ensure that adding return type annotations has not inadvertently altered any logic.

@nrichers nrichers requested a review from validbeck October 11, 2025 00:41
Copy link
Collaborator

@validbeck validbeck left a comment

Choose a reason for hiding this comment

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

🤞🏻

@nrichers nrichers merged commit 4c4b532 into main Oct 15, 2025
9 of 10 checks passed
@nrichers nrichers deleted the manually-refresh-Quarto-docs branch October 15, 2025 15:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

internal Not to be externalized in the release notes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants