Skip to content

Rework landau's documentation and naming convention #103

@drouhling

Description

@drouhling

This is related to #101. [NB(rei): PR which has been merged]

[NB(rei): partially addressed by PR #216 ]

Since we force user to use the equational notations by removing the defintions, we should be very clear on how to use this library. In particular the documentation should:

  • detail how to state a lemma using the notations, e.g. should I use f =O_F g or f = [O_F g of h]?

  • list all the possibilities to prove such relations, with the important steps, e.g. apply: eqoE is not to be forgotten, filter reasoning is possible but thought of as a last resort…

  • clarify anything that can confuse the user about the notations, e.g.:

    • what is the difference between f =o_F g and f = o_F g?
    • why does f =O_ (0 : U) g work but not f =O_(0 : U) g, while f =O_F g does work?
  • what are the naming conventions. I believe this library should be used as bigop: since it is hard and tedious to search lemmas using notations, we should have a clear naming convention so that it is easy to find a lemma by its name.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentation 📝This issue/PR is about documentation of the library / repositoryrenaming/refactoring 🔧This is about a renaming or refactoring in the library

    Type

    No type

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions