Improve docs

NNPDF · Aug 14, 2024 · 872b01b · 872b01b
1 parent 8bce28c
commit 872b01b
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 20 deletions.
diff --git a/pineappl_py/docs/source/implementation.rst b/pineappl_py/docs/source/implementation.rst
diff --git a/pineappl_py/docs/source/index.rst b/pineappl_py/docs/source/index.rst
@@ -1,7 +1,7 @@
 Welcome to PineAPPL
 ===================
 
-This is the Python wrapper for the `Rust PineAPPL library <https://nnpdf.github.io/pineappl/>`_.
+This is the Python wrapper for the `Rust PineAPPL library <https://nnpdf.github.io/pineappl/>`_ using `PyO3 <https://pyo3.rs>`_.
 
 PineAPPL is a computer library that makes it possible to produce fast-interpolation grids for fitting parton distribution functions (PDFs) including corrections of strong and electroweak origin.
 
@@ -18,6 +18,5 @@ We also list some common :doc:`recipes` here.
 
    installation
    recipes
-   implementation
    API <modules/pineappl>
    indices
diff --git a/pineappl_py/docs/source/recipes.rst b/pineappl_py/docs/source/recipes.rst
@@ -13,7 +13,7 @@ How can I convolve a given PineAPPL grid with my PDF?
     import lhapdf
     g = pineappl.grid.Grid.read("path/to/grid.pineappl.lz4")
     pdf = lhapdf.mkPDF("YourPDF", 0)
-    bins = g.convolve(pdf.xfxQ2, pdf.xfxQ2, pdf.alphasQ2)
+    bins = g.convolve_with_one(2212, pdf.xfxQ2, pdf.alphasQ2)
 
 If the grid is actually an FkTable just replace
 
@@ -23,16 +23,11 @@ If the grid is actually an FkTable just replace
 
 .. note::
 
-    For the :meth:`pineappl.pineappl.PyGrid.read` function, both ``.pineappl``
+    For the :meth:`pineappl.grid.Grid.read` function, both ``.pineappl``
     and ``.pineappl.lz4`` extensions are acceptable, as long as they are
     consistent (without ``.lz4`` the grid is assumed not to be compressed, with
     it is assumed compressed).
 
-    This is asymmetric with respect to the
-    :meth:`pineappl.pineappl.PyGrid.write` function, in which the function will
-    refuse to guess, so another version is provided to write a compressed grid,
-    :meth:`pineappl.pineappl.PyGrid.write_lz4`
-
 How can I edit a grid?
 ----------------------
 
@@ -60,9 +55,8 @@ change even the bins themselves.
     remapper = pineappl.bin.BinRemapper(normalizations, limits)
     g.set_remapper(remapper)
 
-For more details about :class:`pineappl.bin.BinRemapper` check also the `Rust
-documentation
-<https://docs.rs/pineappl/latest/pineappl/bin/struct.BinRemapper.html>`_, e.g.
+For more details about :class:`pineappl.bin.BinRemapper` check also
+the Rust documentation of :rustdoc:`pineappl::bin::BinRemapper <bin/struct.BinRemapper.html>`, e.g.
 on how to treat multidimensional distributions.
 
 How can I get the bin configurations from a given PineAPPL grid?