Skip to content

Commit 6e9a308

Browse files
sigurdmjonasfj
andauthored
Clarify relationship between Description and ResolvedDescription (#4579)
* Clarify relationship between Description and ResolvedDescription * Update lib/src/source.dart Co-authored-by: Jonas Finnemann Jensen <[email protected]> --------- Co-authored-by: Jonas Finnemann Jensen <[email protected]>
1 parent 935bec6 commit 6e9a308

File tree

1 file changed

+8
-2
lines changed

1 file changed

+8
-2
lines changed

lib/src/source.dart

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -177,11 +177,17 @@ abstract class Source {
177177
///
178178
/// For a hosted package this would be the host url.
179179
///
180-
/// For a git package this would be the repo url and a ref and a path inside
181-
/// the repo.
180+
/// For a git package this would be the repo url and a ref and a path inside the
181+
/// repo.
182+
///
183+
/// For a path package it is the path.
182184
///
183185
/// This is the information that goes into a `pubspec.yaml` dependency together
184186
/// with a version constraint.
187+
///
188+
/// After resolution we might know more about the specifics of the package that
189+
/// pins the content down (such as its content-hash or git commit id) this is
190+
/// represented by a [ResolvedDescription].
185191
abstract class Description {
186192
Source get source;
187193

0 commit comments

Comments
 (0)