Skip to content

Commit a7c0899

Browse files
committed
doc link to paper
1 parent 05f2312 commit a7c0899

File tree

4 files changed

+13
-5
lines changed

4 files changed

+13
-5
lines changed

.github/workflows/build_gui_apps.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ on:
1919
default: false
2020
type: boolean
2121
push:
22-
branches: [ main, master, test ]
22+
branches: [ gui ]
2323
tags:
2424
- 'v*'
2525
- '*.*.*'

.github/workflows/tests.yml

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,12 @@
11
name: tests
22

3-
on: [push, pull_request]
3+
on:
4+
push:
5+
paths-ignore:
6+
- 'docs/**'
7+
pull_request:
8+
paths-ignore:
9+
- 'docs/**'
410

511
jobs:
612
build:

docs/source/index.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,10 @@ GetDist is a Python package for analysing and plotting Monte Carlo (or other) sa
99
Introduction <intro>
1010
Plot gallery and tutorial <https://getdist.readthedocs.io/en/latest/plot_gallery.html>
1111
GetDist GUI program <gui>
12+
Paper with technical details <https://arxiv.org/abs/1910.13970>
1213

13-
**LLM Integration**: For AI assistants and LLM agents, a comprehensive context document is available at `GetDist LLM Context <https://getdist.readthedocs.io/en/latest/_static/getdist_docs_combined.md>`_.
14+
15+
**LLM Integration**: For AI assistants and LLM agents, a comprehensive `LLM context document <https://getdist.readthedocs.io/en/latest/_static/getdist_docs_combined.md>`_ can be used.
1416
There's also an `AI help assistant <https://cosmocoffee.info/help_assist.php>`_ you can use to ask about the package.
1517

1618
High-level modules for analysing samples and plotting:

getdist/densities.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -207,10 +207,10 @@ def getLimits(self, p, interpGrid=None, accuracy_factor=None):
207207
Get parameter equal-density confidence limits (a credible interval).
208208
If the density is bounded, may only have a one-tail limit.
209209
210-
:param p: list of limits to calculate, e.g. [0.68, 0.95]
210+
:param p: limit to calculate, or list of limits to calculate, e.g. [0.68, 0.95]
211211
:param interpGrid: optional pre-computed cache
212212
:param accuracy_factor: parameter to boost default accuracy for fine sampling
213-
:return: list of (min, max, has_min, has_top) values
213+
:return: list of (min, max, has_min, has_top) values, or tuple fo single limit,
214214
where has_min and has_top are True or False depending on whether lower and upper limit exists
215215
"""
216216
g = interpGrid or self.initLimitGrids(accuracy_factor)

0 commit comments

Comments
 (0)