diff options
| author | Edoardo La Greca | 2025-07-25 19:44:28 +0200 |
|---|---|---|
| committer | Edoardo La Greca | 2025-07-25 19:44:28 +0200 |
| commit | 158d7282ef386531bb1b6e0a7b3dd1c1fa552548 (patch) | |
| tree | 87f9e5f67762b5fbf8d683727b4e1981859d4261 | |
| parent | aede05ff29b2b467677bfb6e872454f4cde4f41f (diff) | |
add clarification in NinePTranslator's documentation
| -rw-r--r-- | src/main/kotlin/NinePTranslator.kt | 5 |
1 files changed, 3 insertions, 2 deletions
diff --git a/src/main/kotlin/NinePTranslator.kt b/src/main/kotlin/NinePTranslator.kt index ebb04c5..a42ea3c 100644 --- a/src/main/kotlin/NinePTranslator.kt +++ b/src/main/kotlin/NinePTranslator.kt @@ -4,8 +4,9 @@ TODO: */ /** - * The [NinePTranslator] interface provides methods that coincide 1:1 with each request and response type in the 9P - * protocol, except for `Rerror` which is handled at occurrence. + * The [NinePTranslator] interface provides methods that coincide 1:1 with each request type in the 9P protocol. Every + * method that can fail, that is, every request that can receive a response with `Rerror` type instead of the same type + * as itself, returns a non-null `String` that contains the error message received in the response. * * Tags are supposed to be managed internally by the class that provides the implementation. * |