search

libgit2 / libgit2sharp

Git + .NET = ❤
http://libgit2.github.com
MIT License
3.15k stars 887 forks source link

The API design on the wiki homepage seems to be outdated #1930

Open klanderfri opened 2 years ago

klanderfri commented 2 years ago

The API design shown at https://github.com/libgit2/libgit2sharp/wiki/Home was last updated in 2011 (commit 338eace3f55ebb22d787012923c219e7c9e03755). If one tries to use it as a guide/manual one will find that the compiler takes issue with several methods missing (for example repo.Commits.StartingAt). It seems like it needs to be updated to match the current code base.

Reproduction steps

  1. Open a new solution in Visal Studio Professional 2017.
  2. Download the libgit2sharp NuGet packages.
  3. Copy and paste the API design code from the wiki home page.
  4. Hit compile.

Expected behavior

The code compiles.

Actual behavior

Compilation errors due to missing methods and properties.

Version of LibGit2Sharp (release number or SHA1)

NuGet-packages:

Operating system(s) tested; .NET runtime tested

.NET Framework 4.6.1

Computer: Utgåva (Edition) Windows 10 Pro Version 20H2 Installerad (Installed) ‎2021-‎09-‎01 OS-version 19042.1348 Gränssnitt (Interface) Windows Feature Experience Pack 120.2212.3920.0

VulumeCode commented 2 years ago

It's pseudocode, these methods never existed. StartingAt would mean something like "search the list until you find a commit with this sha then return that commit and all commits after it."