Skip to content

Commit

Permalink
(Issue #91) Intentionally alter docs.
Browse files Browse the repository at this point in the history
Made additions to .rst and python docstring docs to see that they are rendered
locally by tox, that they are visible in the RTD test rendering for the PR, but
not published in the official, public RTD docs.  They did show up as expected
with tox.

NOTE:  I want these to make it into main so that we do see them automatically
incluced in the official, public RTD docs.  We can then remove them as a hotfix
to test the whole workflow.  Note that these were also added in to generate a
merge conflict with the changes made direclty on main at commit d53cbfe so that
we can test the git workflow a bit as well.
  • Loading branch information
jared321 committed Jul 19, 2024
1 parent 0f3dacb commit 7836954
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 0 deletions.
2 changes: 2 additions & 0 deletions docs/source/intro.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ Taweret for Bayesian Model Mixing
Bayesian Model Mixing
---------------------

__ALLOW THIS INTO MAIN AND REMOVE AS A HOTFIX TO TEST WORKFLOW.__

In computer simulation studies, it is often the case where a set of theoretically \
sound models are considered, each intended to describe the true underlying physical phenomena of interest \
across a sub-region of the domain. These models could differ by their underlying assumptions \
Expand Down
2 changes: 2 additions & 0 deletions src/Taweret/mix/bivariate_linear.py
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@
class BivariateLinear(BaseMixer):

'''
__ALLOW THIS INTO MAIN AND REMOVE AS HOTFIX TO TEST WORKFLOW__.
Local linear Bayesian mixing of two models. This is a general class of
mixing that offer both density (likelihood) and mean mixing methods.
The default mixing method is linear mixing of two likelihoods.
Expand Down

0 comments on commit 7836954

Please sign in to comment.