This is an automated email from the ASF dual-hosted git repository. rcordier pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/james-project.git
commit 30a99e381aac890c4b2efb4a8171c20ab6e06acf Author: Rene Cordier <[email protected]> AuthorDate: Tue Jul 28 17:02:27 2020 +0700 JAMES-3099 Add a little explanation in the README about annotations --- server/protocols/jmap-rfc-8621/doc/README.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/server/protocols/jmap-rfc-8621/doc/README.md b/server/protocols/jmap-rfc-8621/doc/README.md index 32ac876..39cba9a 100644 --- a/server/protocols/jmap-rfc-8621/doc/README.md +++ b/server/protocols/jmap-rfc-8621/doc/README.md @@ -8,4 +8,10 @@ Officially finalized specifications so far regarding JMAP are: * [The core protocol](https://jmap.io/spec-core.html) [[RFC 8620](https://tools.ietf.org/html/rfc8620)] * [JMAP Mail](https://jmap.io/spec-mail.html) [[RFC 8621](https://tools.ietf.org/html/rfc8621)] -Annotations aim at tracking implementation progress in James project. \ No newline at end of file +Annotations aim at tracking implementation progress in James project. + +Annotations are usually represented in the documentation by an `aside` tag. That tag can have two classes: + +* `notice` More like an informative annotation, usually used to mark that a feature has been implemented +* `warning` To get the developer's attention, usually to say that maybe a point or detail of an implemented feature has +not been implemented, or partially \ No newline at end of file --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
