[ https://issues.apache.org/jira/browse/CASSANDRA-18193?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Jacek Lewandowski reassigned CASSANDRA-18193: --------------------------------------------- Assignee: Jacek Lewandowski > Provide design and API documentation > ------------------------------------ > > Key: CASSANDRA-18193 > URL: https://issues.apache.org/jira/browse/CASSANDRA-18193 > Project: Cassandra > Issue Type: Task > Components: Accord > Reporter: Jacek Lewandowski > Assignee: Jacek Lewandowski > Priority: Normal > > Would be great if we have at minimum: > - white paper in a form of an AsciiDoc or Markdown somewhere in the project > tree > - all interfaces and all methods in {{acccord.api}} have API docs explaining > the requirements for the implementations > - enums and their values across the project are documented > - interfaces, abstract classes, or classes that do not inherit from anything > in the project have at least some class level explanation > Eventually, it would really awesome if concepts from the whitepaper are > somehow referenced in the code (or vice-versa). It would make it much easier > to understand the implementation and I believe it would improve reuse of this > project for external applications -- This message was sent by Atlassian Jira (v8.20.10#820010) --------------------------------------------------------------------- To unsubscribe, e-mail: commits-unsubscr...@cassandra.apache.org For additional commands, e-mail: commits-h...@cassandra.apache.org