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.

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

Standardize documentation showing module import path and example #1497

Open
zacharybinger opened this issue Sep 25, 2024 · 2 comments
Open
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request Priority:High High Priority Issue or PR

Comments

@zacharybinger
Copy link
Contributor

Description

Importing models isn't the most obvious to new users. If you look at the documentation there isn't anything to indicate what the module name is and if you look in the code

@declare_process_block_class("ReverseOsmosis1D")
class ReverseOsmosis1DData(ReverseOsmosisBaseData):
    """Standard 1D Reverse Osmosis Unit Model Class."""

it isn't obvious unless you understand what the wrapper is doing (i.e. ReverseOsmosis1DData vs. ReverseOsmosisBaseData vs. ReverseOsmosis1D)

Motivation

Reduce the learning curve of WaterTAP and make the documentation more clear

Possible Implementation

Screenshot 2024-09-25 at 11 49 00 AM

Additional Context

No response

@zacharybinger zacharybinger added the enhancement New feature or request label Sep 25, 2024
@zacharybinger zacharybinger self-assigned this Sep 25, 2024
@zacharybinger zacharybinger changed the title Module import path and example Standardize documentation showing module import path and example Sep 25, 2024
@ksbeattie ksbeattie added documentation Improvements or additions to documentation Priority:Normal Normal Priority Issue or PR labels Sep 26, 2024
@adam-a-a
Copy link
Contributor

adam-a-a commented Oct 1, 2024

One thought-- should we consider a landing page with a table of all unit models and associated import lines? Having it all in one place would be convenient.

@ksbeattie ksbeattie added Priority:High High Priority Issue or PR and removed Priority:Normal Normal Priority Issue or PR labels Dec 19, 2024
@ksbeattie
Copy link
Contributor

This is a really good example for new developers to the project to get experience on opening a PR. It's a pretty straightforward change and there will need to be many of them all across the documentation.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request Priority:High High Priority Issue or PR
Projects
None yet
Development

No branches or pull requests

3 participants