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.

Sign up for GitHub

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

Jump to bottom

Update public API docs #197

Merged
merged 41 commits into from
Nov 27, 2021
Merged

Update public API docs #197

merged 41 commits into from
Nov 27, 2021

Commits on Nov 16, 2021

  1. [lib docs] update basic usage, add license and source sections

    @chrissimpkins
    chrissimpkins committed Nov 16, 2021
    Configuration menu
    Copy the full SHA
    6ca0b17 View commit details
    Browse the repository at this point in the history

  2. [lib] fix variable name in docs

    @chrissimpkins
    chrissimpkins committed Nov 16, 2021
    Configuration menu
    Copy the full SHA
    8c34fea View commit details
    Browse the repository at this point in the history

  3. [lib docs] add link to examples directory sources

    @chrissimpkins
    chrissimpkins committed Nov 16, 2021
    Configuration menu
    Copy the full SHA
    31f3952 View commit details
    Browse the repository at this point in the history

  4. [data_request] expand documentation, add doc tests

    @chrissimpkins
    chrissimpkins committed Nov 16, 2021
    Configuration menu
    Copy the full SHA
    5d04ea6 View commit details
    Browse the repository at this point in the history

  5. [datastore] expand documentation

    @chrissimpkins
    chrissimpkins committed Nov 16, 2021
    Configuration menu
    Copy the full SHA
    a1c45bb View commit details
    Browse the repository at this point in the history

  6. [error] expand documentation

    @chrissimpkins
    chrissimpkins committed Nov 16, 2021
    Configuration menu
    Copy the full SHA
    ce27c67 View commit details
    Browse the repository at this point in the history

  7. [error] add documentation for struct fields

    @chrissimpkins
    chrissimpkins committed Nov 16, 2021
    Configuration menu
    Copy the full SHA
    968b582 View commit details
    Browse the repository at this point in the history

  8. [error] typo fix

    @chrissimpkins
    chrissimpkins committed Nov 16, 2021
    Configuration menu
    Copy the full SHA
    a3416b4 View commit details
    Browse the repository at this point in the history

  9. [error] more struct field documentation

    @chrissimpkins
    chrissimpkins committed Nov 16, 2021
    Configuration menu
    Copy the full SHA
    a65f9dd View commit details
    Browse the repository at this point in the history

  10. [lib] use a Font reference

    @chrissimpkins
    chrissimpkins committed Nov 16, 2021
    Configuration menu
    Copy the full SHA
    a00a138 View commit details
    Browse the repository at this point in the history

  11. Update src/data_request.rs 

    Co-authored-by: Colin Rofls <[email protected]>
    @chrissimpkins @cmyr
    chrissimpkins and cmyr committed Nov 16, 2021
    Configuration menu
    Copy the full SHA
    c1f8b55 View commit details
    Browse the repository at this point in the history

  12. Update src/data_request.rs 

    Co-authored-by: Colin Rofls <[email protected]>
    @chrissimpkins @cmyr
    chrissimpkins and cmyr committed Nov 16, 2021
    Configuration menu
    Copy the full SHA
    f9e807b View commit details
    Browse the repository at this point in the history

  13. Update src/data_request.rs 

    Co-authored-by: Colin Rofls <[email protected]>
    @chrissimpkins @cmyr
    chrissimpkins and cmyr committed Nov 16, 2021
    Configuration menu
    Copy the full SHA
    d61eb17 View commit details
    Browse the repository at this point in the history

  14. Update src/datastore.rs 

    Co-authored-by: Colin Rofls <[email protected]>
    @chrissimpkins @cmyr
    chrissimpkins and cmyr committed Nov 16, 2021
    Configuration menu
    Copy the full SHA
    50de6ee View commit details
    Browse the repository at this point in the history

  15. Update src/error.rs 

    Co-authored-by: Colin Rofls <[email protected]>
    @chrissimpkins @cmyr
    chrissimpkins and cmyr committed Nov 16, 2021
    Configuration menu
    Copy the full SHA
    9055f77 View commit details
    Browse the repository at this point in the history

  16. Update src/error.rs 

    Co-authored-by: Colin Rofls <[email protected]>
    @chrissimpkins @cmyr
    chrissimpkins and cmyr committed Nov 16, 2021
    Configuration menu
    Copy the full SHA
    70eab95 View commit details
    Browse the repository at this point in the history

  17. [font] update documentation

    @chrissimpkins
    chrissimpkins committed Nov 16, 2021
    Configuration menu
    Copy the full SHA
    16899c5 View commit details
    Browse the repository at this point in the history

  18. [error] typo fix

    @chrissimpkins
    chrissimpkins committed Nov 16, 2021
    Configuration menu
    Copy the full SHA
    cdb0a8e View commit details
    Browse the repository at this point in the history

  19. [fontinfo] update documentation

    @chrissimpkins
    chrissimpkins committed Nov 16, 2021
    Configuration menu
    Copy the full SHA
    116581c View commit details
    Browse the repository at this point in the history

  20. [groups] add BTreeMap doc link

    @chrissimpkins
    chrissimpkins committed Nov 16, 2021
    Configuration menu
    Copy the full SHA
    04b21a4 View commit details
    Browse the repository at this point in the history

  21. [guideline] minor documentation updates

    @chrissimpkins
    chrissimpkins committed Nov 16, 2021
    Configuration menu
    Copy the full SHA
    3ccd14e View commit details
    Browse the repository at this point in the history

  22. [identifier] update documentation

    @chrissimpkins
    chrissimpkins committed Nov 16, 2021
    Configuration menu
    Copy the full SHA
    e36fcfc View commit details
    Browse the repository at this point in the history

  23. [kerning] minor documentation updates

    @chrissimpkins
    chrissimpkins committed Nov 16, 2021
    Configuration menu
    Copy the full SHA
    987aab9 View commit details
    Browse the repository at this point in the history

  24. [layer] documentation updates

    @chrissimpkins
    chrissimpkins committed Nov 16, 2021
    Configuration menu
    Copy the full SHA
    8114e9f View commit details
    Browse the repository at this point in the history

  25. [shared_types] update documentation

    @chrissimpkins
    chrissimpkins committed Nov 16, 2021
    Configuration menu
    Copy the full SHA
    c190c41 View commit details
    Browse the repository at this point in the history

  26. [util] minor documentation updates

    @chrissimpkins
    chrissimpkins committed Nov 16, 2021
    Configuration menu
    Copy the full SHA
    581a4ec View commit details
    Browse the repository at this point in the history

  27. [write] documentation updates

    @chrissimpkins
    chrissimpkins committed Nov 16, 2021
    Configuration menu
    Copy the full SHA
    e750f05 View commit details
    Browse the repository at this point in the history

  28. [glyph] update documentation

    @chrissimpkins
    chrissimpkins committed Nov 16, 2021
    Configuration menu
    Copy the full SHA
    e38e55c View commit details
    Browse the repository at this point in the history

  29. [glyph::serialize] update documentation

    @chrissimpkins
    chrissimpkins committed Nov 16, 2021
    Configuration menu
    Copy the full SHA
    098246c View commit details
    Browse the repository at this point in the history

  30. documentation: remove unnecessary "Note" header elements

    @chrissimpkins
    chrissimpkins committed Nov 16, 2021
    Configuration menu
    Copy the full SHA
    1521d5c View commit details
    Browse the repository at this point in the history

  31. [datastore] make ImageStore type alias documentation c/w DataStore ty… 

    …pe alias
    @chrissimpkins
    chrissimpkins committed Nov 16, 2021
    Configuration menu
    Copy the full SHA
    7e0ef96 View commit details
    Browse the repository at this point in the history

  32. documentation: transition Note headers to inline "Note:" annotations.

    @chrissimpkins
    chrissimpkins committed Nov 16, 2021
    Configuration menu
    Copy the full SHA
    e49e7e2 View commit details
    Browse the repository at this point in the history

  33. documentation: "Example" header ==> "Examples" 

    this is consistent with the approach in the std lib.  Plural is used even if there is a single example provided
    @chrissimpkins
    chrissimpkins committed Nov 16, 2021
    Configuration menu
    Copy the full SHA
    dfa5ad1 View commit details
    Browse the repository at this point in the history

  34. [lib] documentation: internal link formatting

    @chrissimpkins
    chrissimpkins committed Nov 16, 2021
    Configuration menu
    Copy the full SHA
    48d62ce View commit details
    Browse the repository at this point in the history

  35. [font] documentation: update load_requested_data examples with API ch… 

    …anges in linebender#201
    @chrissimpkins
    chrissimpkins committed Nov 16, 2021
    Configuration menu
    Copy the full SHA
    8ebd78b View commit details
    Browse the repository at this point in the history

Commits on Nov 22, 2021

  1. Minor edits to Glyph docstrings

    @madig
    madig committed Nov 22, 2021
    Configuration menu
    Copy the full SHA
    cca365c View commit details
    Browse the repository at this point in the history

  2. Minor doc edits

    @madig
    madig committed Nov 22, 2021
    Configuration menu
    Copy the full SHA
    6c9969c View commit details
    Browse the repository at this point in the history

  3. Minor: Drop "immutable" in front of references

    @madig
    madig committed Nov 22, 2021
    Configuration menu
    Copy the full SHA
    c1ebc78 View commit details
    Browse the repository at this point in the history

  4. Minor doc updates

    @madig
    madig committed Nov 22, 2021
    Configuration menu
    Copy the full SHA
    3edf293 View commit details
    Browse the repository at this point in the history

  5. Minor: clarify UFO v1 and 2 are read-only

    @madig
    madig committed Nov 22, 2021
    Configuration menu
    Copy the full SHA
    d0c07fc View commit details
    Browse the repository at this point in the history

Commits on Nov 26, 2021

  1. Minor: Fix docstring

    @madig
    madig committed Nov 26, 2021
    Configuration menu
    Copy the full SHA
    37eba3a View commit details
    Browse the repository at this point in the history