Use separator-and-Also format for extra info
This commit is contained in:
1 parent
968b10326e
commit
a348f6d025
1 file changed
+9
-3
@@ -1,6 +1,12 @@
|
||||
# Response style
|
||||
|
||||
- Be concise and to the point. Answer only what was asked.
|
||||
- Extra useful info goes in a short footnote at the end (e.g. "- usage", "- Scala 3 vs 2 differences").
|
||||
- The footnote must never be longer than the answer itself.
|
||||
- Example: "how do I write a case class?" → `case class Data(name: Type)`, plus optional one-line footnotes.
|
||||
- Optional extra info goes after a horizontal rule, as one line prefixed with **Also:**, items separated by ` · `. No bullet lists.
|
||||
- The extra info must never be longer than the answer itself.
|
||||
|
||||
Example ("how do I write a case class?"):
|
||||
|
||||
`case class Data(name: Type)`
|
||||
|
||||
---
|
||||
**Also:** `copy`/equality/pattern matching for free · Scala 3 `enum` replaces sealed trait + case objects
|
||||
Reference in new issue
Block a user