`final def eq(x$0: Object): Boolean` in Scala doc

[He-Pin]

Compiler version

3.6.3

Minimized code

https://www.scala-lang.org/api/3.x/scala/AnyRef.html

Scary name

Expectation

as it written

[Gedochao]

cc @WojciechMazur @Florian3k

[hamzaremmal]

Expectation

as it written

AnyRef is not "written", it is a class that is fully defined in the compiler (and it is defined as an alias to Object):

scala3/compiler/src/dotty/tools/dotc/core/Definitions.scala

Line 428 in 7b39421

@tu lazy val AnyRefAlias: TypeSymbol = enterAliasType(tpnme.AnyRef, ObjectType)

Of course, the same goes for all the methods with a "scary name":

scala3/compiler/src/dotty/tools/dotc/core/Definitions.scala

Lines 431 to 441 in 7b39421

	@tu lazy val Object_eq: TermSymbol = enterMethod(ObjectClass, nme.eq, methOfAnyRef(BooleanType), Final)
	@tu lazy val Object_ne: TermSymbol = enterMethod(ObjectClass, nme.ne, methOfAnyRef(BooleanType), Final)
	@tu lazy val Object_synchronized: TermSymbol = enterPolyMethod(ObjectClass, nme.synchronized_, 1,
	pt => MethodType(List(pt.paramRefs(0)), pt.paramRefs(0)), Final)
	@tu lazy val Object_clone: TermSymbol = enterMethod(ObjectClass, nme.clone_, MethodType(Nil, ObjectType), Protected)
	@tu lazy val Object_finalize: TermSymbol = enterMethod(ObjectClass, nme.finalize_, MethodType(Nil, UnitType), Protected)
	@tu lazy val Object_notify: TermSymbol = enterMethod(ObjectClass, nme.notify_, MethodType(Nil, UnitType), Final)
	@tu lazy val Object_notifyAll: TermSymbol = enterMethod(ObjectClass, nme.notifyAll_, MethodType(Nil, UnitType), Final)
	@tu lazy val Object_wait: TermSymbol = enterMethod(ObjectClass, nme.wait_, MethodType(Nil, UnitType), Final)
	@tu lazy val Object_waitL: TermSymbol = enterMethod(ObjectClass, nme.wait_, MethodType(LongType :: Nil, UnitType), Final)
	@tu lazy val Object_waitLI: TermSymbol = enterMethod(ObjectClass, nme.wait_, MethodType(LongType :: IntType :: Nil, UnitType), Final)

I agree that it would be nice to not have these synthetic names on a user-facing page. We shouldn't consider this ticket as a bug, but rather better documentation. We don't have a label for that at the moment, @Gedochao I think we should create one, what do you think? (I have at least one ticket of this kind that I can open)