From 835167a0e5b3aa2cfc814ced9603147d05a7b36e Mon Sep 17 00:00:00 2001
From: Matthieu Schaller <schaller@strw.leidenuniv.nl>
Date: Thu, 2 Aug 2018 18:21:01 +0200
Subject: [PATCH] Documentation fixes.

---
 src/gravity/Default/gravity.h | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/src/gravity/Default/gravity.h b/src/gravity/Default/gravity.h
index 7e8139ea93..bfd36b6b78 100644
--- a/src/gravity/Default/gravity.h
+++ b/src/gravity/Default/gravity.h
@@ -164,9 +164,13 @@ __attribute__((always_inline)) INLINE static void gravity_init_gpart(
  * Multiplies the forces and accelerations by the appropiate constants.
  * Applies cosmological correction for periodic BCs.
  *
+ * No need to apply the potential normalisation correction for periodic
+ * BCs here since we do not compute the potential.
+ *
  * @param gp The particle to act upon
  * @param const_G Newton's constant in internal units.
  * @param potential_normalisation Term to be added to all the particles.
+ * @param Are we using periodic BCs?
  */
 __attribute__((always_inline)) INLINE static void gravity_end_force(
     struct gpart* gp, float const_G, const float potential_normalisation,
-- 
GitLab