raboof/pekko
1
0
Fork 0
Code Issues Pull requests Projects Releases 6 Packages Wiki Activity Actions 10

Docs: sort all operators by method name in left-hand menu (#28900)

Browse source
This commit is contained in:
Enno 2020-04-28 16:58:00 +02:00 • committed by GitHub
parent fcd960ad78
commit bb4940b027
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
42 changed files with 214 additions and 218 deletions
Download patch file Download diff file Expand all files Collapse all files

18
project/StreamOperatorsIndexGenerator.scala
View file

@ -70,8 +70,7 @@ object StreamOperatorsIndexGenerator extends AutoPlugin {
"alsoToGraph",
"orElseGraph",
"divertToGraph",
"zipWithGraph",
)
"zipWithGraph")
// FIXME document these methods as well
val pendingTestCases = Map(
@ -98,14 +97,8 @@ object StreamOperatorsIndexGenerator extends AutoPlugin {
"fromGraph",
"actorSubscriber",
"foldAsync",
"newOnCompleteStage",
),
"Compression" -> Seq(
"inflate",
"gunzip",
)
)
"newOnCompleteStage"),
"Compression" -> Seq("inflate", "gunzip"))
val ignore =
Set("equals", "hashCode", "notify", "notifyAll", "wait", "toString", "getClass") ++
@ -230,7 +223,10 @@ object StreamOperatorsIndexGenerator extends AutoPlugin {
"# Operators\n\n" +
tables +
"\n\n@@@ index\n\n" +
groupedDefs.map { case (_, method, md) => s"* [${methodToShow(method)}]($md)" }.mkString("\n") + "\n\n@@@\n"
groupedDefs
.sortBy { case (_, method, _) => method.toLowerCase }
.map { case (_, method, md) => s"* [$method]($md)" }
.mkString("\n") + "\n\n@@@\n"
if (!file.exists || IO.read(file) != content) IO.write(file, content)
Seq(file)