dotnet / dotnet/dotnet-api-docs

What is "the sort order"?

Offen
#976 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen
area-System.Runtime dotnet-api/prod Pri2 untriaged
Vorherrschende Sprache
C#
Sterne
949
Forks
1.7k
Ø Merge
2 T. 19 Std.
Gemergte PRs (30 T.)
52

Beschreibung

> indicates whether the current object is before, after, or in the same position as the specified object in the sort order.

What is "the sort order"?

I SUPPOSE (from the example) that the tuples are compared lexicographically?

If yes, might I suggest mentioning this explicitely in the docs?

IMHO it'd be better if the reader wouldn't have to infer such info from the examples or own testing but just read it...

---
#### Document Details

⚠ *Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.*

* ID: fc0ad1e6-8f64-2941-8315-0b6357ec0516
* Version Independent ID: 89251c1d-b7f5-e02d-5132-df55fac76621
* Content: [Tuple<T1,T2>.IComparable.CompareTo(Object) Method (System)](https://docs.microsoft.com/en-us/dotnet/api/system.tuple-2.system-icomparable-compareto?view=netcore-2.1)
* Content Source: [xml/System/Tuple`2.xml](https://github.com/dotnet/dotnet-api-docs/blob/master/xml/System/Tuple`2.xml)
* Product: **dotnet-api**
* GitHub Login: @dotnet-bot
* Microsoft Alias: **dotnetcontent**

Beitragsleitfaden

Beitragsleitfaden öffnen

Rechercherichtung

Beginne damit, xml/System/Tuple`2.xml und die verlinkte Seite Tuple.IComparable.CompareTo(Object) zu öffnen. Prüfe die bestehende Formulierung anhand der Frage des Issues zum lexikografischen Vergleich und aktualisiere anschließend die Dokumentation, sodass „sort order“ ausdrücklich genannt wird; fertig ist die Änderung, wenn ein Leser dies verstehen kann, ohne aus Beispielen schlussfolgern zu müssen.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
csharp
Bereich
documentation
Issue-Typ
Dokumentation
Schwierigkeit
1/5
Geschätzter Aufwand
Unter einer Stunde
Aktivitätsstatus
Veraltet
Klarheit
Klar beschrieben
Anfängerfreundlichkeit
35/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.