I recently completed 2 PRs, the documentation generated from the source code is displaying incomplete/obsolete data on the Kivy website.
dampedscroll.py
Source: https://github.com/kivy/kivy/blob/master/kivy/effects/dampedscroll.py
Web: https://kivy.org/doc/master/api-kivy.effects.dampedscroll.html#module-kivy.effects.dampedscroll
Issue: description of properties is missing, a function that is not documented is showing up.
scrollview.py
Source: https://github.com/kivy/kivy/blob/master/kivy/uix/scrollview.py
Web: https://kivy.org/doc/master/api-kivy.uix.scrollview.html#module-kivy.uix.scrollview
Issues: descriptions of MANY properties are missing from documenation.
Details:
damped scroll.py Missing Content:
rubber_band_coeff = NumericProperty(0.55)
'''Rubber band resistance coefficient. Higher values = less resistance.
Flutter/iOS typically use ~0.55. Lower values (0.3-0.4) feel stiffer,
higher values (0.6-0.8) feel more elastic.
:attr:`rubber_band_coeff` is a :class:`~kivy.properties.NumericProperty` and
defaults to 0.55.
'''
spring_mass = NumericProperty(1.0)
'''Mass for spring simulation (affects bounce-back speed).
:attr:`spring_mass` is a :class:`~kivy.properties.NumericProperty` and
defaults to 1.0.
'''
spring_stiffness = NumericProperty(100.0)
'''Stiffness for spring simulation (affects bounce-back speed).
:attr:`spring_stiffness` is a :class:`~kivy.properties.NumericProperty` and
defaults to 100.0.
'''
min_overscroll = NumericProperty(.5)
'''An overscroll less than this amount will be normalized to 0.
:attr:`min_overscroll` is a :class:`~kivy.properties.NumericProperty` and
defaults to .5.
'''
Obsolete content for update_volocity() is showing up on the website. Here is the related code:
def update_velocity(self, dt):
# Update velocity with critically damped spring physics.
# If we're not moving and not overscrolled, stop
if abs(self.velocity) <= self.min_velocity and abs(
self.overscroll) < self.min_overscroll:
self.velocity = 0
self.overscroll = 0
return
# Check if we're in overscroll and should apply spring forces
if abs(self.overscroll) > self.min_overscroll and not self.is_manual:
# Use critically damped spring simulation
self._apply_spring_force(dt)
else:
# Normal momentum scrolling with exponential friction
if abs(self.overscroll) < self.min_overscroll:
self.overscroll = 0
# Standard friction
friction_force = self.velocity * self.friction * dt / self.std_dt
self.velocity = self.velocity - friction_force
if not self.is_manual:
self.apply_distance(self.velocity * dt)
self.trigger_velocity_update()
FWIW, I was able to generate the docs on my machine, but it required me to delete cache files.
I recently completed 2 PRs, the documentation generated from the source code is displaying incomplete/obsolete data on the Kivy website.
dampedscroll.py
Source: https://github.com/kivy/kivy/blob/master/kivy/effects/dampedscroll.py
Web: https://kivy.org/doc/master/api-kivy.effects.dampedscroll.html#module-kivy.effects.dampedscroll
Issue: description of properties is missing, a function that is not documented is showing up.
scrollview.py
Source: https://github.com/kivy/kivy/blob/master/kivy/uix/scrollview.py
Web: https://kivy.org/doc/master/api-kivy.uix.scrollview.html#module-kivy.uix.scrollview
Issues: descriptions of MANY properties are missing from documenation.
Details:
damped scroll.py Missing Content:
Obsolete content for update_volocity() is showing up on the website. Here is the related code:
FWIW, I was able to generate the docs on my machine, but it required me to delete cache files.