minor: docs

This commit is contained in:
mockturtl
2015-05-10 15:14:32 -04:00
parent af257af882
commit 9ff25ec2fe
4 changed files with 8 additions and 7 deletions

View File

@ -1,11 +1,12 @@
changelog changelog
========= =========
This project follows [pub-flavored semantic versioning][pub-semver]. This project follows [pub-flavored semantic versioning][pub-semver]. ([more][pub-semver-readme])
Release notes are available on [github][notes]. Release notes are available on [github][notes].
[pub-semver]: https://www.dartlang.org/tools/pub/versioning.html#semantic-versions [pub-semver]: https://www.dartlang.org/tools/pub/versioning.html#semantic-versions
[pub-semver-readme]: https://pub.dartlang.org/packages/pub_semver
[notes]: https://github.com/mockturtl/dotenv/releases [notes]: https://github.com/mockturtl/dotenv/releases
HEAD HEAD
@ -23,7 +24,7 @@ HEAD
----- -----
- [deprecated] `Parser` internals will become private. [#3][] - [deprecated] `Parser` internals will become private. [#3][]
- `#unquote` `#strip`, `#swallow`, `#parseOne`, `#surroundingQuote`, `#interpolate` - `#unquote`, `#strip`, `#swallow`, `#parseOne`, `#surroundingQuote`, `#interpolate`
- [new] support variable substitution - [new] support variable substitution
- [deps] migrate to [test][] - [deps] migrate to [test][]
- [deps] bump [logging][] - [deps] bump [logging][]

View File

@ -4,9 +4,9 @@ dotenv
Load environment variables at runtime from a `.env` file. Load environment variables at runtime from a `.env` file.
[![Pub Version][pub-badge]][pub] [![Pub Version][pub-badge]][pub]
[![Build Status][ci-badge]][ci] [![Build Status][ci-badge]][ci]
NB: Travis uses [`test_runner`][], which has not yet moved off `unittest`. _NB: Travis uses [`test_runner`][], which has not yet moved off `unittest`._
[`test_runner`]: https://github.com/google/test_runner.dart/blob/master/pubspec.yaml [`test_runner`]: https://github.com/google/test_runner.dart/blob/master/pubspec.yaml
@ -18,7 +18,7 @@ NB: Travis uses [`test_runner`][], which has not yet moved off `unittest`.
usage usage
----- -----
Prefix the library import and call `load()`, exposing the `env` map Prefix the library import and call `load()`, exposing the `env` map
with a top-level getter. with a top-level getter.
```dart ```dart

View File

@ -67,7 +67,7 @@ class Parser {
return _surroundQuotes.firstMatch(val).group(1); return _surroundQuotes.firstMatch(val).group(1);
} }
/// Strip quotes (single or double) surrounding a value. /// Remove quotes (single or double) surrounding a value.
@Deprecated('Exposed for testing') // FIXME @Deprecated('Exposed for testing') // FIXME
String unquote(String val) => String unquote(String val) =>
val.replaceFirstMapped(_surroundQuotes, (m) => m[2]).trim(); val.replaceFirstMapped(_surroundQuotes, (m) => m[2]).trim();

View File

@ -1,7 +1,7 @@
tool tool
==== ====
Consider calling these in a git pre-commit hook. _Consider calling these in a git pre-commit hook._
### [fmt.sh][] ### [fmt.sh][]