Skip to content

Commit ffa4c3b

Browse files
authoredAug 8, 2024··
Replace all "fully-qualified" strings in the docs with "fully qualified" (#2763)
As explained in https://www.merriam-webster.com/grammar/6-common-hypercorrections-and-how-to-avoid-them, hyphen is not needed since 'fully' can refer only to the adjective 'qualified'.
1 parent 4798072 commit ffa4c3b

File tree

7 files changed

+7
-7
lines changed

7 files changed

+7
-7
lines changed
 

‎core/commonMain/src/kotlinx/serialization/Annotations.kt

+1-1
Original file line numberDiff line numberDiff line change
@@ -129,7 +129,7 @@ public annotation class Serializer(
129129
* the name of the property, e.g. by `Json`.
130130
*
131131
* By default, [SerialDescriptor.serialName] and [SerialDescriptor.getElementName]
132-
* are associated with fully-qualified name of the target class and the name of the property respectively.
132+
* are associated with fully qualified name of the target class and the name of the property respectively.
133133
* Applying this annotation changes the visible name to the given [value]:
134134
*
135135
* ```

‎core/commonMain/src/kotlinx/serialization/descriptors/SerialDescriptor.kt

+1-1
Original file line numberDiff line numberDiff line change
@@ -147,7 +147,7 @@ public interface SerialDescriptor {
147147
/**
148148
* Serial name of the descriptor that identifies a pair of the associated serializer and target class.
149149
*
150-
* For generated and default serializers, the serial name should be equal to the corresponding class's fully-qualified name
150+
* For generated and default serializers, the serial name should be equal to the corresponding class's fully qualified name
151151
* or, if overridden, [SerialName].
152152
* Custom serializers should provide a unique serial name that identifies both the serializable class and
153153
* the serializer itself, ignoring type arguments, if they are present, for example: `my.package.LongAsTrimmedString`

‎core/commonMain/src/kotlinx/serialization/internal/AbstractPolymorphicSerializer.kt

+1-1
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ import kotlin.reflect.*
1717
*
1818
* By default, without special support from [Encoder], polymorphic types are serialized as list with
1919
* two elements: class [serial name][SerialDescriptor.serialName] (String) and the object itself.
20-
* Serial name equals to fully-qualified class name by default and can be changed via @[SerialName] annotation.
20+
* Serial name equals to fully qualified class name by default and can be changed via @[SerialName] annotation.
2121
*/
2222
@InternalSerializationApi
2323
@OptIn(ExperimentalSerializationApi::class)

‎docs/builtin-classes.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -383,7 +383,7 @@ which is explained in the [Polymorphism. Objects](polymorphism.md#objects) secti
383383
<!--- TEST -->
384384

385385
> Serialization of objects is format specific. Other formats may represent objects differently,
386-
> e.g. using their fully-qualified names.
386+
> e.g. using their fully qualified names.
387387
388388
### Duration
389389

‎docs/polymorphism.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -293,7 +293,7 @@ fun main() {
293293

294294
> You can get the full code [here](../guide/example/example-poly-08.kt).
295295
296-
An object serializes as an empty class, also using its fully-qualified class name as type by default:
296+
An object serializes as an empty class, also using its fully qualified class name as type by default:
297297

298298
```text
299299
[{"type":"example.examplePoly08.EmptyResponse"},{"type":"example.examplePoly08.TextResponse","text":"OK"}]

‎formats/json/commonMain/src/kotlinx/serialization/json/JsonConfiguration.kt

+1-1
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ public class JsonConfiguration @OptIn(ExperimentalSerializationApi::class) inter
6363
* Defines which classes and objects should have their serial name included in the json as so-called class discriminator.
6464
*
6565
* Class discriminator is a JSON field added by kotlinx.serialization that has [JsonBuilder.classDiscriminator] as a key (`type` by default),
66-
* and class' serial name as a value (fully-qualified name by default, can be changed with [SerialName] annotation).
66+
* and class' serial name as a value (fully qualified name by default, can be changed with [SerialName] annotation).
6767
*
6868
* Class discriminator is important for serializing and deserializing [polymorphic class hierarchies](https://github.com/Kotlin/kotlinx.serialization/blob/master/docs/polymorphism.md#sealed-classes).
6969
* Default [ClassDiscriminatorMode.POLYMORPHIC] mode adds discriminator only to polymorphic classes.

‎formats/json/commonMain/src/kotlinx/serialization/json/internal/FormatLanguage.kt

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ import kotlinx.serialization.InternalSerializationApi
66
* Multiplatform analogue of `org.intellij.lang.annotations.Language` annotation.
77
*
88
* An alias is used instead of class, because the actual class in the JVM will conflict with the class from the stdlib -
9-
* we want to avoid the situation with different classes having the same fully-qualified name.
9+
* we want to avoid the situation with different classes having the same fully qualified name.
1010
* [see](https://github.com/JetBrains/java-annotations/issues/34)
1111
*
1212
* Specifies that an element of the program represents a string that is a source code on a specified language.

0 commit comments

Comments
 (0)
Please sign in to comment.