Skip to content
This repository was archived by the owner on Jul 19, 2023. It is now read-only.
This repository was archived by the owner on Jul 19, 2023. It is now read-only.

Document working vs WIP features #242

@ghost

Description

The current documentation can be misleading regarding which features are ready vs in-progress. I'm not sure if there's a standard practice for this, but if we can summarize the current state in this issue I'll update the README.

Relatedly, we might consider adding a header to the README that warns users that this library is still a WIP, and not to depend on it for anything critical. Again, not sure if there's already a standard practice for that.

So far, I'm aware that the following are broken / not implemented:

  • UpwindDifference
  • generally anything for 3+ dimentions

Let's make that list complete and specific.

This will hopefully avoid surprising users, as well as reduce the flow of "yes, we know" issue submissions.

Metadata

Metadata

Assignees

No one assigned

    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