Add dotnet nuget why documentation #30497
Closed
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
tdykstra
reviewed
Aug 5, 2022
| @@ -0,0 +1,78 @@ | |||
| --- | |||
| title: dotnet nuget why command | |||
| description: The 'dotnet nuget why' command provides the user to view the dependency graph of a package. | |||
There was a problem hiding this comment.
Suggested change
| description: The 'dotnet nuget why' command provides the user to view the dependency graph of a package. | |
| description: The 'dotnet nuget why' command shows the dependency graph of a package. |
|
|
||
| - **`--framework <FRAMEWORK>`** | ||
|
|
||
| The NuGet sources to use when searching for newer packages. Requires the `--outdated` option. |
There was a problem hiding this comment.
The --outdated option isn't in the doc here.
|
|
||
| ## Description | ||
|
|
||
| The `dotnet list package` command provides a way to print out the dependency graph for a package to allow users to understand the nature of top-level packages and their transitive dependencies. This command is dependent on the `project.assets.json` file being present in the project. The following example shows the output of the `dotnet nuget why` command for `packageA` which has dependencies in `projectNameA` and `projectNameB`: |
There was a problem hiding this comment.
This would be easier to understand with actual command output using real package/project names rather than packageA and B and projectA and B.
| --- | ||
| # dotnet nuget why | ||
|
|
||
| **This article applies to:** ✔️ .NET Core 3.1 SDK and later versions |
There was a problem hiding this comment.
Which preview is this in? We will want to make sure it doesn't get merged before it's available, and this applies-to text should be updated to .NET 7 Preview SDK.
| dotnet nuget why packageA --framework net6.0 | ||
| ``` | ||
|
|
||
| - Print dependency graph of `packageA`, the package has dependencies in multiple projects so all dependencies are printed by default: |
There was a problem hiding this comment.
Suggested change
| - Print dependency graph of `packageA`, the package has dependencies in multiple projects so all dependencies are printed by default: | |
| - Print dependency graph of `packageA`. The package has dependencies in multiple projects so all dependencies are printed by default: |
But the command only looks at one project per the arguments section, so it's not clear what this means by referring to multiple projects.
pkulikov
reviewed
Aug 18, 2022
|
|
||
| ## Description | ||
|
|
||
| The `dotnet list package` command provides a way to print out the dependency graph for a package to allow users to understand the nature of top-level packages and their transitive dependencies. This command is dependent on the `project.assets.json` file being present in the project. The following example shows the output of the `dotnet nuget why` command for `packageA` which has dependencies in `projectNameA` and `projectNameB`: |
There was a problem hiding this comment.
Suggested change
| The `dotnet list package` command provides a way to print out the dependency graph for a package to allow users to understand the nature of top-level packages and their transitive dependencies. This command is dependent on the `project.assets.json` file being present in the project. The following example shows the output of the `dotnet nuget why` command for `packageA` which has dependencies in `projectNameA` and `projectNameB`: | |
| The `dotnet nuget why` command provides a way to print out the dependency graph for a package to allow users to understand the nature of top-level packages and their transitive dependencies. This command is dependent on the `project.assets.json` file being present in the project. The following example shows the output of the `dotnet nuget why` command for `packageA` which has dependencies in `projectNameA` and `projectNameB`: |
tdykstra
requested changes
Sep 7, 2022
|
Hi @pragnya17 Can you address the comments on this PR? Once you do that, we can merge it. |
|
Closing due to no response from PR author. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Add documentation for
dotnet nuget why. The implementation of this command is still in progress: NuGet/Home#11782.