Reduce Parameter API #121
Merged
Reduce Parameter API #121
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
tomalrussell
force-pushed
the
feature/parameters
branch
from
faf56dc
to
2923a32
Compare
willu47
suggested changes
Jan 24, 2018
There was a problem hiding this comment.
I like the new api documentation - particularly the table showing classes with the one-liner description. It's much easier to navigate.
I miss the readme landing page for the documentation with our badges and "Word from our sponsor" section, also giving continuity between the readthedocs and github view. Perhaps we move detailed install and config out of the readme and into the relevant pages in the docs and keep a simplified readme?
- expose ParameterList and Narrative directly on smif.parameters - move implementation to hidden submodules - create Parameter class to hold individual parameter metadata Intended to reduce the API size and be more explicit about data required (replacing plain dicts with data object).
- gives finer control over auto-generated docs - requires better-apidoc package, added to test-requirements
…l for ReadTheDocs
tomalrussell
force-pushed
the
feature/parameters
branch
from
395274c
to
564eca6
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Testing an opinion on how to organise subpackages and expose classes in
__init__.pyAlso introducing a
Parameterobject and some (hopefully) simplification ofParameterList.