holoviz
document ListProxy
Not documenting it was deliberate, since it is not meant for user applications, but your question suggests that we should rename it _ListProxy to convey its internal status?
Not documenting it was deliberate, since it is not meant for user applications, but your question suggests that we should rename it
_ListProxyto convey its internal status?
it would be easier to just say so in the docstring eh?
ListProxy was added in https://github.com/holoviz/param/pull/598. At the time all the Parameters were declared in the top-level __init__.py file, this object was added to that file. When Param was refactored and parameters.py was created, I imported ListProxy from parameters.py in the top-level __init__.py and added it to __all__, enforcing its "public API status". This is all a bit unfortunate as it does indeed feel like internal API and its name is close to a Parameter name which can cause confusion. I'm in favor of renaming it to _ListProxy but would like to ask @philippjfr his opinion first. If he agrees it can be renamed, we'll need to go through a (quick) deprecation cycle.
Yes, it should be private and in fact the plan was to slowly deprecate the APIs that made us add it in the first place.
slowly deprecate the APIs that made us add it in the first place
I'd welcome more details on this :)