Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Doc tweaks #504

Merged
merged 2 commits into from
Jul 3, 2021
Merged

Doc tweaks #504

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d26b878
Updated reference manual
jbednar Jul 3, 2021
aac688f
Updated roadmap
jbednar Jul 3, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 4 additions & 9 deletions doc/reference.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,9 @@ API Reference Manual
********************

The Param API Reference Manual provides a comprehensive reference for
all modules, functions, classes, and methods provided by Param.

Module Structure
________________
all modules, functions, classes, and methods provided by Param. See the
`User Guide <../user_guide>`_ for a more readable overview and explanations;
this material duplicates what is available from `help(obj)` for each object.

`parameterized`_
Parameter, Parameterized, and other core classes and methods
Expand All @@ -19,10 +18,6 @@ ________________
`version`_
Automatic generation of version strings using version control

Modules
_______



parameterized Module
====================
Expand Down Expand Up @@ -90,7 +85,7 @@ version Module


.. _parameterized: #parameterized-module
.. _param: #__init__-module
.. _param: #param-module
.. _ipython: #ipython-module
.. _serializer: #serializer-module
.. _version: #version-module
Expand Down
6 changes: 3 additions & 3 deletions doc/roadmap.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@ Param is a mature library (originally from 2003) that changes very slowly and ve

Currently scheduled plans:

- Make there be documentation. We have funding for this and work is already underway. This includes both user guide/tutorial material and reference material, covering both how it's currently used in HoloViz and on the underlying design and general functionality independent of HoloViz (as indeed it predates all of HoloViz). This will be a major step forward in how suitable Param is for general usage.
- Make there be documentation. (Currently underway, as of 7/2021!). This will be a major step forward in how suitable Param is for general usage.

- Improve the Param website (same time as docs; just make it look decent!)
- Improve the Param website (Currently very basic!)

- Clean up the Parameterized namespace (remove nearly all methods not on .param) and other API warts, scheduled for Param 2.0 since those are breaking changes. See https://github.com/holoviz/param/issues/154 and https://github.com/holoviz/param/issues/233.

Expand All @@ -16,7 +16,7 @@ Other items that are not yet scheduled but would be great to have:

- Integrate more fully with Python 3 language features like [type annotations](https://www.python.org/dev/peps/pep-0526) and/or [data classes], e.g. to respect and validate against declared types without requiring an explicit `param.Parameter` declaration, and to better support IDE type-checking features.

- Integrate and interoperate more fully with other frameworks like Django models, Traitlets, attrs, Django models, or swagger/OpenAPI, each of which capture or can use similar information about parameter names, values, and constraints and so in many cases can easily be converted from one to the other.
- Integrate and interoperate more fully with other frameworks like Django models, Traitlets, attrs, Django models, Pydantic, or swagger/OpenAPI, each of which capture or can use similar information about parameter names, values, and constraints and so in many cases can easily be converted from one to the other.

- Improve support for Param in editors, automatic formatting tools, linters, document generators, and other tools that process Python code and could be made to have special-purpose optimizations specifically for Parameterized objects.

Expand Down