Skip to content
Permalink

Comparing changes

Choose two branches to see what’s changed or to start a new pull request. If you need to, you can also or learn more about diff comparisons.

Open a pull request

Create a new pull request by comparing changes across two branches. If you need to, you can also . Learn more about diff comparisons here.
base repository: NixOS/nixpkgs
base: 06834f72628e
Choose a base ref
...
head repository: NixOS/nixpkgs
compare: 141f63c29b26
Choose a head ref
  • 6 commits
  • 5 files changed
  • 2 contributors

Commits on Oct 29, 2018

  1. lib/trivial: Update function comments for doc generation 

    Expands on some of the function comments and add some of the
special syntaxes recognised by nixdoc.
    @tazjin
    tazjin committed Oct 29, 2018
    Copy the full SHA
    09772db View commit details
    Browse the repository at this point in the history

  2. lib/strings: Update documentation comments for doc generation 

    Updates documentation comments with extra information for nixdoc[1]
compatibility.

Some documentation strings have additionally been reworded for
clarity.

"Faux types" are added where applicable, but some functions do things
that are not trivially representable in the type notation used so they
were ignored for this purpose.

[1]: https://github.com/tazjin/nixdoc
    @tazjin
    tazjin committed Oct 29, 2018
    Copy the full SHA
    34cd613 View commit details
    Browse the repository at this point in the history

  3. lib/lists: Update documentation comments for doc generation 

    Updates documentation comments with extra information for nixdoc[1]
compatibility.

[1]: https://github.com/tazjin/nixdoc
    @tazjin
    tazjin committed Oct 29, 2018
    Copy the full SHA
    20d8273 View commit details
    Browse the repository at this point in the history

  4. lib/debug: Update documentation comments for docs generation 

    Documents functions in `lib.debug` for docs generation with nixdoc.

Note that type signatures and clearer descriptions are still missing
on some of these functions, but this is good enough for a first run.
    @tazjin
    tazjin committed Oct 29, 2018
    Copy the full SHA
    a53c60d View commit details
    Browse the repository at this point in the history

  5. lib/options: Update documentation comments for docs generation 

    Documents functions in `lib.options` for docs generation with nixdoc.

The formatting change in the `mkOption` arguments is due to the way
`nixdoc` parses documentation comments on pattern arguments. It's not
ideal, but it works.
    @tazjin
    tazjin committed Oct 29, 2018
    Copy the full SHA
    acb1efb View commit details
    Browse the repository at this point in the history

Commits on Nov 10, 2018

  1. Merge pull request #49387 from tazjin/chore/backport-doc-comments 

    Backport documentation comment changes to release-18.09
    @samueldr
    samueldr committed Nov 10, 2018
    Copy the full SHA
    141f63c View commit details
    Browse the repository at this point in the history