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

Link to relevant documentation in generated files #12

Open
rixx opened this issue Mar 2, 2023 · 0 comments
Open

Link to relevant documentation in generated files #12

rixx opened this issue Mar 2, 2023 · 0 comments
Labels
enhancement New feature or request

Comments

@rixx
Copy link

rixx commented Mar 2, 2023

I think it could be very helpful to link to the relevant documentation sections in the generated files, so that it's easier for users to get going.

For example, the main __init__.py could include a docstring like

    """Plugin configuration.

    See https://docs.netbox.dev/en/stable/plugins/development/#pluginconfig-attributes
    for a list of all possible attributes."""

(Or shorter, or versioned, but you get the idea.)

When I start a new plugin and open a models.py or filters.py, I pretty much always want to look up the main tutorial or documentation anyway, and I imagine it's the same for most of us. Deleting the line if it's not that useful isn't much hassle either, as in the beginning, you move a lot of things around anyway.

(Happy to provide a PR if you think this is a good idea.)

@rixx rixx added the enhancement New feature or request label Mar 2, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant