Skip to content

Out of date code examples should be removed from the core documentation, or fixed #1

Description

@jacklovell

There are a number of examples in the "Code Examples Gallery" which are either very out of date or are tied to a particular experiment. This is causing confusion for new users of Cherab, who download the package and try to run the examples and get error messages.

Examples which are merely out of date and can easily be brought up to date should be modernised, and ones which are experiment-specific - particularly those which require access to CAD mesh files stored locally at different institutions - should be removed from the core documentation and preferably placed in documentation for the site-specific packages. Basically, anything which can't be run from a laptop connected to coffee shop WiFi shouldn't really be in the core documentation.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions