Skip to content

Sort constructors deterministically #3089

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from
Draft

Sort constructors deterministically #3089

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions plugins/base/src/main/kotlin/translators/documentables/DefaultPageCreator.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@ open class DefaultPageCreator(
val props = classlikes.flatMap { it.filteredProperties }
val entries = classlikes.flatMap { if (it is DEnum) it.entries else emptyList() }

val childrenPages = constructors.map(::pageForFunction) +
val childrenPages = sortDivergentElementsDeterministically(constructors).map(::pageForFunction) + // to keep order after page merging of overloads, see [SameMethodNamePageMergerStrategy]
if (mergeImplicitExpectActualDeclarations)
nestedClasslikes.mergeClashingDocumentable().map(::pageForClasslikes) +
functions.mergeClashingDocumentable().map(::pageForFunctions) +
Expand Down Expand Up @@ -402,7 +402,7 @@ open class DefaultPageCreator(
2,
ContentKind.Constructors,
constructorsToDocumented.groupBy { it.name }
.map { (_, v) -> v.first().name to v },
.map { (_, v) -> v.first().name to sortDivergentElementsDeterministically(v) },
@Suppress("UNCHECKED_CAST")
(constructorsToDocumented as List<Documentable>).sourceSets,
needsAnchors = true,
Expand Down Expand Up @@ -683,7 +683,7 @@ open class DefaultPageCreator(
* @param elements can contain types (annotation/class/interface/object/typealias), functions and properties
* @return the original list if it has one or zero elements
*/
private fun sortDivergentElementsDeterministically(elements: List<Documentable>): List<Documentable> =
private fun <T : Documentable> sortDivergentElementsDeterministically(elements: List<T>): List<T> =
elements.takeIf { it.size > 1 } // the majority are single-element lists, but no real benchmarks done
?.sortedWith(divergentDocumentableComparator)
?: elements
Expand Down