From e3a8a36e7c4df0fe740ee0b8c0fc4452c7d66749 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mattias=20Linn=C3=A9r?= Date: Wed, 16 Mar 2022 16:02:00 +0100 Subject: [PATCH 1/8] First idea of event categories --- eiffel-syntax-and-usage/event-categories.md | 27 +++++++++++++++++++++ 1 file changed, 27 insertions(+) create mode 100644 eiffel-syntax-and-usage/event-categories.md diff --git a/eiffel-syntax-and-usage/event-categories.md b/eiffel-syntax-and-usage/event-categories.md new file mode 100644 index 00000000..0792831b --- /dev/null +++ b/eiffel-syntax-and-usage/event-categories.md @@ -0,0 +1,27 @@ + + +| Category | Name | Abbrevation | +|:-------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:-----------:| +| Activity | [EiffelActivityCanceledEvent](https://github.com/eiffel-community/eiffel/blob/master/eiffel-vocabulary/EiffelActivityCanceledEvent.md) | ActC | +| Activity | [EiffelActivityFinishedEvent](https://github.com/eiffel-community/eiffel/blob/master/eiffel-vocabulary/EiffelActivityFinishedEvent.md) | ActF | +| Activity | [EiffelActivityStartedEvent](https://github.com/eiffel-community/eiffel/blob/master/eiffel-vocabulary/EiffelActivityStartedEvent.md) | ActS | +| Activity | [EiffelActivityTriggeredEvent](https://github.com/eiffel-community/eiffel/blob/master/eiffel-vocabulary/EiffelActivityTriggeredEvent.md) | ActT | +| Artifact | [EiffelArtifactCreatedEvent](https://github.com/eiffel-community/eiffel/blob/master/eiffel-vocabulary/EiffelArtifactCreatedEvent.md) | ArtC | +| Artifact | [EiffelArtifactPublishedEvent](https://github.com/eiffel-community/eiffel/blob/master/eiffel-vocabulary/EiffelArtifactPublishedEvent.md) | ArtP | +| Artifact | [EiffelArtifactReusedEvent](https://github.com/eiffel-community/eiffel/blob/master/eiffel-vocabulary/EiffelArtifactReusedEvent.md) | ArtR | +| Baseline | [EiffelFlowContextDefinedEvent](https://github.com/eiffel-community/eiffel/blob/master/eiffel-vocabulary/EiffelFlowContextDefinedEvent.md) | FCD | +| Baseline | [EiffelCompositionDefinedEvent](https://github.com/eiffel-community/eiffel/blob/master/eiffel-vocabulary/EiffelCompositionDefinedEvent.md) | CD | +| Environment | [EiffelEnvironmentDefinedEvent](https://github.com/eiffel-community/eiffel/blob/master/eiffel-vocabulary/EiffelEnvironmentDefinedEvent.md) | ED | +| Issue | [EiffelIssueVerifiedEvent](https://github.com/eiffel-community/eiffel/blob/master/eiffel-vocabulary/EiffelIssueVerifiedEvent.md) | IV | +| Issue | [EiffelIssueDefinedEvent](https://github.com/eiffel-community/eiffel/blob/master/eiffel-vocabulary/EiffelIssueDefinedEvent.md) | IssD | +| Notification | [EiffelAnnouncementPublishedEvent](https://github.com/eiffel-community/eiffel/blob/master/eiffel-vocabulary/EiffelAnnouncementPublishedEvent.md) | AnnP | +| Source | [EiffelSourceChangeCreatedEvent](https://github.com/eiffel-community/eiffel/blob/master/eiffel-vocabulary/EiffelSourceChangeCreatedEvent.md) | SCC | +| Source | [EiffelSourceChangeSubmittedEvent](https://github.com/eiffel-community/eiffel/blob/master/eiffel-vocabulary/EiffelSourceChangeSubmittedEvent.md) | SCS | +| Test | [EiffelTestCaseCanceledEvent](https://github.com/eiffel-community/eiffel/blob/master/eiffel-vocabulary/EiffelTestCaseCanceledEvent.md) | TCC | +| Test | [EiffelTestCaseFinishedEvent](https://github.com/eiffel-community/eiffel/blob/master/eiffel-vocabulary/EiffelTestCaseFinishedEvent.md) | TCF | +| Test | [EiffelTestCaseStartedEvent](https://github.com/eiffel-community/eiffel/blob/master/eiffel-vocabulary/EiffelTestCaseStartedEvent.md) | TSS | +| Test | [EiffelTestCaseTriggeredEvent](https://github.com/eiffel-community/eiffel/blob/master/eiffel-vocabulary/EiffelTestCaseTriggeredEvent.md) | TCT | +| Test | [EiffelTestExecutionRecipeCollectionCreatedEvent](https://github.com/eiffel-community/eiffel/blob/master/eiffel-vocabulary/EiffelTestExecutionRecipeCollectionCreatedEvent.md) | TERCC | +| Test | [EiffelTestSuiteFinishedEvent](https://github.com/eiffel-community/eiffel/blob/master/eiffel-vocabulary/EiffelTestSuiteFinishedEvent.md) | TSF | +| Test | [EiffelTestSuiteStartedEvent](https://github.com/eiffel-community/eiffel/blob/master/eiffel-vocabulary/EiffelTestSuiteStartedEvent.md) | TSS | +| Verdict | [EiffelConfidenceLevelModifiedEvent](https://github.com/eiffel-community/eiffel/blob/master/eiffel-vocabulary/EiffelConfidenceLevelModifiedEvent.md) | CLM | From fd7597e80b3c85d312dc4a163dfa2d1bba3df4d5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mattias=20Linn=C3=A9r?= Date: Wed, 27 Jul 2022 15:24:46 +0200 Subject: [PATCH 2/8] Step version of Black --- tox.ini | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tox.ini b/tox.ini index 7fc9ec0d..9a85f3f5 100644 --- a/tox.ini +++ b/tox.ini @@ -28,7 +28,7 @@ basepython = python3 [testenv:black] deps = - black==21.12b0 + black==22.3.0 commands = black --check --diff . [testenv:flake8] From 76999f24e854088e30dc0689612a58a81227b4a4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mattias=20Linn=C3=A9r?= Date: Wed, 27 Jul 2022 17:16:14 +0200 Subject: [PATCH 3/8] Add intro and give each category a color --- eiffel-syntax-and-usage/event-categories.md | 71 +++++++++++++-------- 1 file changed, 46 insertions(+), 25 deletions(-) diff --git a/eiffel-syntax-and-usage/event-categories.md b/eiffel-syntax-and-usage/event-categories.md index 0792831b..b57f1fb7 100644 --- a/eiffel-syntax-and-usage/event-categories.md +++ b/eiffel-syntax-and-usage/event-categories.md @@ -1,27 +1,48 @@ +# Event Categories +The Eiffel protocol specifies each event on its own. For convenience reasons the +protocol specifies them together in categories. Use the following categories to +group events together for ease of talking about them or in reasoning. To make +pictures with Eiffel events consistent throughout the documentation we have +assigned each category a color picked from the +[Unicodes full list of geometric emoji](https://unicode.org/emoji/charts/full-emoji-list.html#geometric) -| Category | Name | Abbrevation | -|:-------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:-----------:| -| Activity | [EiffelActivityCanceledEvent](https://github.com/eiffel-community/eiffel/blob/master/eiffel-vocabulary/EiffelActivityCanceledEvent.md) | ActC | -| Activity | [EiffelActivityFinishedEvent](https://github.com/eiffel-community/eiffel/blob/master/eiffel-vocabulary/EiffelActivityFinishedEvent.md) | ActF | -| Activity | [EiffelActivityStartedEvent](https://github.com/eiffel-community/eiffel/blob/master/eiffel-vocabulary/EiffelActivityStartedEvent.md) | ActS | -| Activity | [EiffelActivityTriggeredEvent](https://github.com/eiffel-community/eiffel/blob/master/eiffel-vocabulary/EiffelActivityTriggeredEvent.md) | ActT | -| Artifact | [EiffelArtifactCreatedEvent](https://github.com/eiffel-community/eiffel/blob/master/eiffel-vocabulary/EiffelArtifactCreatedEvent.md) | ArtC | -| Artifact | [EiffelArtifactPublishedEvent](https://github.com/eiffel-community/eiffel/blob/master/eiffel-vocabulary/EiffelArtifactPublishedEvent.md) | ArtP | -| Artifact | [EiffelArtifactReusedEvent](https://github.com/eiffel-community/eiffel/blob/master/eiffel-vocabulary/EiffelArtifactReusedEvent.md) | ArtR | -| Baseline | [EiffelFlowContextDefinedEvent](https://github.com/eiffel-community/eiffel/blob/master/eiffel-vocabulary/EiffelFlowContextDefinedEvent.md) | FCD | -| Baseline | [EiffelCompositionDefinedEvent](https://github.com/eiffel-community/eiffel/blob/master/eiffel-vocabulary/EiffelCompositionDefinedEvent.md) | CD | -| Environment | [EiffelEnvironmentDefinedEvent](https://github.com/eiffel-community/eiffel/blob/master/eiffel-vocabulary/EiffelEnvironmentDefinedEvent.md) | ED | -| Issue | [EiffelIssueVerifiedEvent](https://github.com/eiffel-community/eiffel/blob/master/eiffel-vocabulary/EiffelIssueVerifiedEvent.md) | IV | -| Issue | [EiffelIssueDefinedEvent](https://github.com/eiffel-community/eiffel/blob/master/eiffel-vocabulary/EiffelIssueDefinedEvent.md) | IssD | -| Notification | [EiffelAnnouncementPublishedEvent](https://github.com/eiffel-community/eiffel/blob/master/eiffel-vocabulary/EiffelAnnouncementPublishedEvent.md) | AnnP | -| Source | [EiffelSourceChangeCreatedEvent](https://github.com/eiffel-community/eiffel/blob/master/eiffel-vocabulary/EiffelSourceChangeCreatedEvent.md) | SCC | -| Source | [EiffelSourceChangeSubmittedEvent](https://github.com/eiffel-community/eiffel/blob/master/eiffel-vocabulary/EiffelSourceChangeSubmittedEvent.md) | SCS | -| Test | [EiffelTestCaseCanceledEvent](https://github.com/eiffel-community/eiffel/blob/master/eiffel-vocabulary/EiffelTestCaseCanceledEvent.md) | TCC | -| Test | [EiffelTestCaseFinishedEvent](https://github.com/eiffel-community/eiffel/blob/master/eiffel-vocabulary/EiffelTestCaseFinishedEvent.md) | TCF | -| Test | [EiffelTestCaseStartedEvent](https://github.com/eiffel-community/eiffel/blob/master/eiffel-vocabulary/EiffelTestCaseStartedEvent.md) | TSS | -| Test | [EiffelTestCaseTriggeredEvent](https://github.com/eiffel-community/eiffel/blob/master/eiffel-vocabulary/EiffelTestCaseTriggeredEvent.md) | TCT | -| Test | [EiffelTestExecutionRecipeCollectionCreatedEvent](https://github.com/eiffel-community/eiffel/blob/master/eiffel-vocabulary/EiffelTestExecutionRecipeCollectionCreatedEvent.md) | TERCC | -| Test | [EiffelTestSuiteFinishedEvent](https://github.com/eiffel-community/eiffel/blob/master/eiffel-vocabulary/EiffelTestSuiteFinishedEvent.md) | TSF | -| Test | [EiffelTestSuiteStartedEvent](https://github.com/eiffel-community/eiffel/blob/master/eiffel-vocabulary/EiffelTestSuiteStartedEvent.md) | TSS | -| Verdict | [EiffelConfidenceLevelModifiedEvent](https://github.com/eiffel-community/eiffel/blob/master/eiffel-vocabulary/EiffelConfidenceLevelModifiedEvent.md) | CLM | +| Category | Color | +|:-------------|:-----:| +| Activity | 🔵 | +| Artifact | 🔴 | +| Baseline | 🟠 | +| Environment | 🟣 | +| Issue | ⚪ | +| Notification | ⚫ | +| Source | 🟢 | +| Test | 🟡 | +| Verdict | 🟤 | + +The events and their categories. + +| Category | Name | Abbreviation | Color | +|:-------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:------------:|:-----:| +| Activity | [EiffelActivityCanceledEvent](https://github.com/eiffel-community/eiffel/blob/master/eiffel-vocabulary/EiffelActivityCanceledEvent.md) | ActC | 🔵 | +| Activity | [EiffelActivityFinishedEvent](https://github.com/eiffel-community/eiffel/blob/master/eiffel-vocabulary/EiffelActivityFinishedEvent.md) | ActF | 🔵 | +| Activity | [EiffelActivityStartedEvent](https://github.com/eiffel-community/eiffel/blob/master/eiffel-vocabulary/EiffelActivityStartedEvent.md) | ActS | 🔵 | +| Activity | [EiffelActivityTriggeredEvent](https://github.com/eiffel-community/eiffel/blob/master/eiffel-vocabulary/EiffelActivityTriggeredEvent.md) | ActT | 🔵 | +| Artifact | [EiffelArtifactCreatedEvent](https://github.com/eiffel-community/eiffel/blob/master/eiffel-vocabulary/EiffelArtifactCreatedEvent.md) | ArtC | 🔴 | +| Artifact | [EiffelArtifactPublishedEvent](https://github.com/eiffel-community/eiffel/blob/master/eiffel-vocabulary/EiffelArtifactPublishedEvent.md) | ArtP | 🔴 | +| Artifact | [EiffelArtifactReusedEvent](https://github.com/eiffel-community/eiffel/blob/master/eiffel-vocabulary/EiffelArtifactReusedEvent.md) | ArtR | 🔴 | +| Baseline | [EiffelFlowContextDefinedEvent](https://github.com/eiffel-community/eiffel/blob/master/eiffel-vocabulary/EiffelFlowContextDefinedEvent.md) | FCD | 🟠 | +| Baseline | [EiffelCompositionDefinedEvent](https://github.com/eiffel-community/eiffel/blob/master/eiffel-vocabulary/EiffelCompositionDefinedEvent.md) | CD | 🟠 | +| Environment | [EiffelEnvironmentDefinedEvent](https://github.com/eiffel-community/eiffel/blob/master/eiffel-vocabulary/EiffelEnvironmentDefinedEvent.md) | ED | 🟣 | +| Issue | [EiffelIssueVerifiedEvent](https://github.com/eiffel-community/eiffel/blob/master/eiffel-vocabulary/EiffelIssueVerifiedEvent.md) | IV | ⚪ | +| Issue | [EiffelIssueDefinedEvent](https://github.com/eiffel-community/eiffel/blob/master/eiffel-vocabulary/EiffelIssueDefinedEvent.md) | IssD | ⚪ | +| Notification | [EiffelAnnouncementPublishedEvent](https://github.com/eiffel-community/eiffel/blob/master/eiffel-vocabulary/EiffelAnnouncementPublishedEvent.md) | AnnP | ⚫ | +| Source | [EiffelSourceChangeCreatedEvent](https://github.com/eiffel-community/eiffel/blob/master/eiffel-vocabulary/EiffelSourceChangeCreatedEvent.md) | SCC | 🟢 | +| Source | [EiffelSourceChangeSubmittedEvent](https://github.com/eiffel-community/eiffel/blob/master/eiffel-vocabulary/EiffelSourceChangeSubmittedEvent.md) | SCS | 🟢 | +| Test | [EiffelTestCaseCanceledEvent](https://github.com/eiffel-community/eiffel/blob/master/eiffel-vocabulary/EiffelTestCaseCanceledEvent.md) | TCC | 🟡 | +| Test | [EiffelTestCaseFinishedEvent](https://github.com/eiffel-community/eiffel/blob/master/eiffel-vocabulary/EiffelTestCaseFinishedEvent.md) | TCF | 🟡 | +| Test | [EiffelTestCaseStartedEvent](https://github.com/eiffel-community/eiffel/blob/master/eiffel-vocabulary/EiffelTestCaseStartedEvent.md) | TSS | 🟡 | +| Test | [EiffelTestCaseTriggeredEvent](https://github.com/eiffel-community/eiffel/blob/master/eiffel-vocabulary/EiffelTestCaseTriggeredEvent.md) | TCT | 🟡 | +| Test | [EiffelTestExecutionRecipeCollectionCreatedEvent](https://github.com/eiffel-community/eiffel/blob/master/eiffel-vocabulary/EiffelTestExecutionRecipeCollectionCreatedEvent.md) | TERCC | 🟡 | +| Test | [EiffelTestSuiteFinishedEvent](https://github.com/eiffel-community/eiffel/blob/master/eiffel-vocabulary/EiffelTestSuiteFinishedEvent.md) | TSF | 🟡 | +| Test | [EiffelTestSuiteStartedEvent](https://github.com/eiffel-community/eiffel/blob/master/eiffel-vocabulary/EiffelTestSuiteStartedEvent.md) | TSS | 🟡 | +| Verdict | [EiffelConfidenceLevelModifiedEvent](https://github.com/eiffel-community/eiffel/blob/master/eiffel-vocabulary/EiffelConfidenceLevelModifiedEvent.md) | CLM | 🟤 | From 1f5653ca19a93338b63eba52a8cf3448a7a0e004 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mattias=20Linn=C3=A9r?= Date: Fri, 29 Jul 2022 16:53:24 +0200 Subject: [PATCH 4/8] Reduce the amount of categories and add link in main README.md --- README.md | 1 + eiffel-syntax-and-usage/event-categories.md | 27 ++++++++++----------- 2 files changed, 14 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 4a9e365f..fa94b934 100644 --- a/README.md +++ b/README.md @@ -45,6 +45,7 @@ Visit [Eiffel Community](https://eiffel-community.github.io) to get started and 1. [Versioning](./eiffel-syntax-and-usage/versioning.md) 1. [Compositions and Validity Checking](./eiffel-syntax-and-usage/compositions-and-validity-checking.md) 1. [Security](./eiffel-syntax-and-usage/security.md) + 1. [Event Categories](./eiffel-syntax-and-usage/event-categories.md) 1. The Eiffel Vocabulary 1. [EiffelActivityTriggeredEvent (ActT)](./eiffel-vocabulary/EiffelActivityTriggeredEvent.md) 1. [EiffelActivityCanceledEvent (ActC)](./eiffel-vocabulary/EiffelActivityCanceledEvent.md) diff --git a/eiffel-syntax-and-usage/event-categories.md b/eiffel-syntax-and-usage/event-categories.md index b57f1fb7..5c7b6bc1 100644 --- a/eiffel-syntax-and-usage/event-categories.md +++ b/eiffel-syntax-and-usage/event-categories.md @@ -1,20 +1,19 @@ # Event Categories The Eiffel protocol specifies each event on its own. For convenience reasons the -protocol specifies them together in categories. Use the following categories to -group events together for ease of talking about them or in reasoning. To make -pictures with Eiffel events consistent throughout the documentation we have -assigned each category a color picked from the +protocol also provides a description on how to group them together in +categories. Use the following categories to group events together for ease of +talking about them or in reasoning. To make pictures with Eiffel events +consistent throughout the documentation we have assigned each category a color +picked from the [Unicodes full list of geometric emoji](https://unicode.org/emoji/charts/full-emoji-list.html#geometric) | Category | Color | |:-------------|:-----:| | Activity | 🔵 | | Artifact | 🔴 | -| Baseline | 🟠 | -| Environment | 🟣 | -| Issue | ⚪ | -| Notification | ⚫ | +| Definition | 🟠 | +| Notification | 🟣 | | Source | 🟢 | | Test | 🟡 | | Verdict | 🟤 | @@ -30,12 +29,11 @@ The events and their categories. | Artifact | [EiffelArtifactCreatedEvent](https://github.com/eiffel-community/eiffel/blob/master/eiffel-vocabulary/EiffelArtifactCreatedEvent.md) | ArtC | 🔴 | | Artifact | [EiffelArtifactPublishedEvent](https://github.com/eiffel-community/eiffel/blob/master/eiffel-vocabulary/EiffelArtifactPublishedEvent.md) | ArtP | 🔴 | | Artifact | [EiffelArtifactReusedEvent](https://github.com/eiffel-community/eiffel/blob/master/eiffel-vocabulary/EiffelArtifactReusedEvent.md) | ArtR | 🔴 | -| Baseline | [EiffelFlowContextDefinedEvent](https://github.com/eiffel-community/eiffel/blob/master/eiffel-vocabulary/EiffelFlowContextDefinedEvent.md) | FCD | 🟠 | -| Baseline | [EiffelCompositionDefinedEvent](https://github.com/eiffel-community/eiffel/blob/master/eiffel-vocabulary/EiffelCompositionDefinedEvent.md) | CD | 🟠 | -| Environment | [EiffelEnvironmentDefinedEvent](https://github.com/eiffel-community/eiffel/blob/master/eiffel-vocabulary/EiffelEnvironmentDefinedEvent.md) | ED | 🟣 | -| Issue | [EiffelIssueVerifiedEvent](https://github.com/eiffel-community/eiffel/blob/master/eiffel-vocabulary/EiffelIssueVerifiedEvent.md) | IV | ⚪ | -| Issue | [EiffelIssueDefinedEvent](https://github.com/eiffel-community/eiffel/blob/master/eiffel-vocabulary/EiffelIssueDefinedEvent.md) | IssD | ⚪ | -| Notification | [EiffelAnnouncementPublishedEvent](https://github.com/eiffel-community/eiffel/blob/master/eiffel-vocabulary/EiffelAnnouncementPublishedEvent.md) | AnnP | ⚫ | +| Definition | [EiffelFlowContextDefinedEvent](https://github.com/eiffel-community/eiffel/blob/master/eiffel-vocabulary/EiffelFlowContextDefinedEvent.md) | FCD | 🟠 | +| Definition | [EiffelCompositionDefinedEvent](https://github.com/eiffel-community/eiffel/blob/master/eiffel-vocabulary/EiffelCompositionDefinedEvent.md) | CD | 🟠 | +| Definition | [EiffelEnvironmentDefinedEvent](https://github.com/eiffel-community/eiffel/blob/master/eiffel-vocabulary/EiffelEnvironmentDefinedEvent.md) | ED | 🟠 | +| Definition | [EiffelIssueDefinedEvent](https://github.com/eiffel-community/eiffel/blob/master/eiffel-vocabulary/EiffelIssueDefinedEvent.md) | IssD | 🟠 | +| Notification | [EiffelAnnouncementPublishedEvent](https://github.com/eiffel-community/eiffel/blob/master/eiffel-vocabulary/EiffelAnnouncementPublishedEvent.md) | AnnP | 🟣 | | Source | [EiffelSourceChangeCreatedEvent](https://github.com/eiffel-community/eiffel/blob/master/eiffel-vocabulary/EiffelSourceChangeCreatedEvent.md) | SCC | 🟢 | | Source | [EiffelSourceChangeSubmittedEvent](https://github.com/eiffel-community/eiffel/blob/master/eiffel-vocabulary/EiffelSourceChangeSubmittedEvent.md) | SCS | 🟢 | | Test | [EiffelTestCaseCanceledEvent](https://github.com/eiffel-community/eiffel/blob/master/eiffel-vocabulary/EiffelTestCaseCanceledEvent.md) | TCC | 🟡 | @@ -46,3 +44,4 @@ The events and their categories. | Test | [EiffelTestSuiteFinishedEvent](https://github.com/eiffel-community/eiffel/blob/master/eiffel-vocabulary/EiffelTestSuiteFinishedEvent.md) | TSF | 🟡 | | Test | [EiffelTestSuiteStartedEvent](https://github.com/eiffel-community/eiffel/blob/master/eiffel-vocabulary/EiffelTestSuiteStartedEvent.md) | TSS | 🟡 | | Verdict | [EiffelConfidenceLevelModifiedEvent](https://github.com/eiffel-community/eiffel/blob/master/eiffel-vocabulary/EiffelConfidenceLevelModifiedEvent.md) | CLM | 🟤 | +| Verdict | [EiffelIssueVerifiedEvent](https://github.com/eiffel-community/eiffel/blob/master/eiffel-vocabulary/EiffelIssueVerifiedEvent.md) | IV | 🟤 | From 82f5d69ceac64d867fd7b4b64427c51ed93c2a62 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mattias=20Linn=C3=A9r?= Date: Fri, 29 Jul 2022 16:58:29 +0200 Subject: [PATCH 5/8] Change colors to improve listing readability --- eiffel-syntax-and-usage/event-categories.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/eiffel-syntax-and-usage/event-categories.md b/eiffel-syntax-and-usage/event-categories.md index 5c7b6bc1..bb96ce74 100644 --- a/eiffel-syntax-and-usage/event-categories.md +++ b/eiffel-syntax-and-usage/event-categories.md @@ -12,8 +12,8 @@ picked from the |:-------------|:-----:| | Activity | 🔵 | | Artifact | 🔴 | -| Definition | 🟠 | -| Notification | 🟣 | +| Definition | 🟣 | +| Notification | 🟠 | | Source | 🟢 | | Test | 🟡 | | Verdict | 🟤 | @@ -29,11 +29,11 @@ The events and their categories. | Artifact | [EiffelArtifactCreatedEvent](https://github.com/eiffel-community/eiffel/blob/master/eiffel-vocabulary/EiffelArtifactCreatedEvent.md) | ArtC | 🔴 | | Artifact | [EiffelArtifactPublishedEvent](https://github.com/eiffel-community/eiffel/blob/master/eiffel-vocabulary/EiffelArtifactPublishedEvent.md) | ArtP | 🔴 | | Artifact | [EiffelArtifactReusedEvent](https://github.com/eiffel-community/eiffel/blob/master/eiffel-vocabulary/EiffelArtifactReusedEvent.md) | ArtR | 🔴 | -| Definition | [EiffelFlowContextDefinedEvent](https://github.com/eiffel-community/eiffel/blob/master/eiffel-vocabulary/EiffelFlowContextDefinedEvent.md) | FCD | 🟠 | -| Definition | [EiffelCompositionDefinedEvent](https://github.com/eiffel-community/eiffel/blob/master/eiffel-vocabulary/EiffelCompositionDefinedEvent.md) | CD | 🟠 | -| Definition | [EiffelEnvironmentDefinedEvent](https://github.com/eiffel-community/eiffel/blob/master/eiffel-vocabulary/EiffelEnvironmentDefinedEvent.md) | ED | 🟠 | -| Definition | [EiffelIssueDefinedEvent](https://github.com/eiffel-community/eiffel/blob/master/eiffel-vocabulary/EiffelIssueDefinedEvent.md) | IssD | 🟠 | -| Notification | [EiffelAnnouncementPublishedEvent](https://github.com/eiffel-community/eiffel/blob/master/eiffel-vocabulary/EiffelAnnouncementPublishedEvent.md) | AnnP | 🟣 | +| Definition | [EiffelFlowContextDefinedEvent](https://github.com/eiffel-community/eiffel/blob/master/eiffel-vocabulary/EiffelFlowContextDefinedEvent.md) | FCD | 🟣 | +| Definition | [EiffelCompositionDefinedEvent](https://github.com/eiffel-community/eiffel/blob/master/eiffel-vocabulary/EiffelCompositionDefinedEvent.md) | CD | 🟣 | +| Definition | [EiffelEnvironmentDefinedEvent](https://github.com/eiffel-community/eiffel/blob/master/eiffel-vocabulary/EiffelEnvironmentDefinedEvent.md) | ED | 🟣 | +| Definition | [EiffelIssueDefinedEvent](https://github.com/eiffel-community/eiffel/blob/master/eiffel-vocabulary/EiffelIssueDefinedEvent.md) | IssD | 🟣 | +| Notification | [EiffelAnnouncementPublishedEvent](https://github.com/eiffel-community/eiffel/blob/master/eiffel-vocabulary/EiffelAnnouncementPublishedEvent.md) | AnnP | 🟠 | | Source | [EiffelSourceChangeCreatedEvent](https://github.com/eiffel-community/eiffel/blob/master/eiffel-vocabulary/EiffelSourceChangeCreatedEvent.md) | SCC | 🟢 | | Source | [EiffelSourceChangeSubmittedEvent](https://github.com/eiffel-community/eiffel/blob/master/eiffel-vocabulary/EiffelSourceChangeSubmittedEvent.md) | SCS | 🟢 | | Test | [EiffelTestCaseCanceledEvent](https://github.com/eiffel-community/eiffel/blob/master/eiffel-vocabulary/EiffelTestCaseCanceledEvent.md) | TCC | 🟡 | From eba951492e3c2d7ef927151b0f17b268a0209391 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mattias=20Linn=C3=A9r?= Date: Fri, 29 Jul 2022 17:00:50 +0200 Subject: [PATCH 6/8] Fix abbreviation of IssueDefined --- eiffel-syntax-and-usage/event-categories.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/eiffel-syntax-and-usage/event-categories.md b/eiffel-syntax-and-usage/event-categories.md index bb96ce74..464facd7 100644 --- a/eiffel-syntax-and-usage/event-categories.md +++ b/eiffel-syntax-and-usage/event-categories.md @@ -32,7 +32,7 @@ The events and their categories. | Definition | [EiffelFlowContextDefinedEvent](https://github.com/eiffel-community/eiffel/blob/master/eiffel-vocabulary/EiffelFlowContextDefinedEvent.md) | FCD | 🟣 | | Definition | [EiffelCompositionDefinedEvent](https://github.com/eiffel-community/eiffel/blob/master/eiffel-vocabulary/EiffelCompositionDefinedEvent.md) | CD | 🟣 | | Definition | [EiffelEnvironmentDefinedEvent](https://github.com/eiffel-community/eiffel/blob/master/eiffel-vocabulary/EiffelEnvironmentDefinedEvent.md) | ED | 🟣 | -| Definition | [EiffelIssueDefinedEvent](https://github.com/eiffel-community/eiffel/blob/master/eiffel-vocabulary/EiffelIssueDefinedEvent.md) | IssD | 🟣 | +| Definition | [EiffelIssueDefinedEvent](https://github.com/eiffel-community/eiffel/blob/master/eiffel-vocabulary/EiffelIssueDefinedEvent.md) | ID | 🟣 | | Notification | [EiffelAnnouncementPublishedEvent](https://github.com/eiffel-community/eiffel/blob/master/eiffel-vocabulary/EiffelAnnouncementPublishedEvent.md) | AnnP | 🟠 | | Source | [EiffelSourceChangeCreatedEvent](https://github.com/eiffel-community/eiffel/blob/master/eiffel-vocabulary/EiffelSourceChangeCreatedEvent.md) | SCC | 🟢 | | Source | [EiffelSourceChangeSubmittedEvent](https://github.com/eiffel-community/eiffel/blob/master/eiffel-vocabulary/EiffelSourceChangeSubmittedEvent.md) | SCS | 🟢 | From 700409125e7e6c2bc7e247d459a5a9afffa8f9b6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mattias=20Linn=C3=A9r?= Date: Wed, 14 Sep 2022 15:17:45 +0200 Subject: [PATCH 7/8] Fixes after review --- eiffel-syntax-and-usage/event-categories.md | 52 ++++++++++----------- 1 file changed, 26 insertions(+), 26 deletions(-) diff --git a/eiffel-syntax-and-usage/event-categories.md b/eiffel-syntax-and-usage/event-categories.md index 464facd7..c9c381db 100644 --- a/eiffel-syntax-and-usage/event-categories.md +++ b/eiffel-syntax-and-usage/event-categories.md @@ -6,7 +6,7 @@ categories. Use the following categories to group events together for ease of talking about them or in reasoning. To make pictures with Eiffel events consistent throughout the documentation we have assigned each category a color picked from the -[Unicodes full list of geometric emoji](https://unicode.org/emoji/charts/full-emoji-list.html#geometric) +[Unicode's full list of geometric emojis](https://unicode.org/emoji/charts/full-emoji-list.html#geometric). | Category | Color | |:-------------|:-----:| @@ -20,28 +20,28 @@ picked from the The events and their categories. -| Category | Name | Abbreviation | Color | -|:-------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:------------:|:-----:| -| Activity | [EiffelActivityCanceledEvent](https://github.com/eiffel-community/eiffel/blob/master/eiffel-vocabulary/EiffelActivityCanceledEvent.md) | ActC | 🔵 | -| Activity | [EiffelActivityFinishedEvent](https://github.com/eiffel-community/eiffel/blob/master/eiffel-vocabulary/EiffelActivityFinishedEvent.md) | ActF | 🔵 | -| Activity | [EiffelActivityStartedEvent](https://github.com/eiffel-community/eiffel/blob/master/eiffel-vocabulary/EiffelActivityStartedEvent.md) | ActS | 🔵 | -| Activity | [EiffelActivityTriggeredEvent](https://github.com/eiffel-community/eiffel/blob/master/eiffel-vocabulary/EiffelActivityTriggeredEvent.md) | ActT | 🔵 | -| Artifact | [EiffelArtifactCreatedEvent](https://github.com/eiffel-community/eiffel/blob/master/eiffel-vocabulary/EiffelArtifactCreatedEvent.md) | ArtC | 🔴 | -| Artifact | [EiffelArtifactPublishedEvent](https://github.com/eiffel-community/eiffel/blob/master/eiffel-vocabulary/EiffelArtifactPublishedEvent.md) | ArtP | 🔴 | -| Artifact | [EiffelArtifactReusedEvent](https://github.com/eiffel-community/eiffel/blob/master/eiffel-vocabulary/EiffelArtifactReusedEvent.md) | ArtR | 🔴 | -| Definition | [EiffelFlowContextDefinedEvent](https://github.com/eiffel-community/eiffel/blob/master/eiffel-vocabulary/EiffelFlowContextDefinedEvent.md) | FCD | 🟣 | -| Definition | [EiffelCompositionDefinedEvent](https://github.com/eiffel-community/eiffel/blob/master/eiffel-vocabulary/EiffelCompositionDefinedEvent.md) | CD | 🟣 | -| Definition | [EiffelEnvironmentDefinedEvent](https://github.com/eiffel-community/eiffel/blob/master/eiffel-vocabulary/EiffelEnvironmentDefinedEvent.md) | ED | 🟣 | -| Definition | [EiffelIssueDefinedEvent](https://github.com/eiffel-community/eiffel/blob/master/eiffel-vocabulary/EiffelIssueDefinedEvent.md) | ID | 🟣 | -| Notification | [EiffelAnnouncementPublishedEvent](https://github.com/eiffel-community/eiffel/blob/master/eiffel-vocabulary/EiffelAnnouncementPublishedEvent.md) | AnnP | 🟠 | -| Source | [EiffelSourceChangeCreatedEvent](https://github.com/eiffel-community/eiffel/blob/master/eiffel-vocabulary/EiffelSourceChangeCreatedEvent.md) | SCC | 🟢 | -| Source | [EiffelSourceChangeSubmittedEvent](https://github.com/eiffel-community/eiffel/blob/master/eiffel-vocabulary/EiffelSourceChangeSubmittedEvent.md) | SCS | 🟢 | -| Test | [EiffelTestCaseCanceledEvent](https://github.com/eiffel-community/eiffel/blob/master/eiffel-vocabulary/EiffelTestCaseCanceledEvent.md) | TCC | 🟡 | -| Test | [EiffelTestCaseFinishedEvent](https://github.com/eiffel-community/eiffel/blob/master/eiffel-vocabulary/EiffelTestCaseFinishedEvent.md) | TCF | 🟡 | -| Test | [EiffelTestCaseStartedEvent](https://github.com/eiffel-community/eiffel/blob/master/eiffel-vocabulary/EiffelTestCaseStartedEvent.md) | TSS | 🟡 | -| Test | [EiffelTestCaseTriggeredEvent](https://github.com/eiffel-community/eiffel/blob/master/eiffel-vocabulary/EiffelTestCaseTriggeredEvent.md) | TCT | 🟡 | -| Test | [EiffelTestExecutionRecipeCollectionCreatedEvent](https://github.com/eiffel-community/eiffel/blob/master/eiffel-vocabulary/EiffelTestExecutionRecipeCollectionCreatedEvent.md) | TERCC | 🟡 | -| Test | [EiffelTestSuiteFinishedEvent](https://github.com/eiffel-community/eiffel/blob/master/eiffel-vocabulary/EiffelTestSuiteFinishedEvent.md) | TSF | 🟡 | -| Test | [EiffelTestSuiteStartedEvent](https://github.com/eiffel-community/eiffel/blob/master/eiffel-vocabulary/EiffelTestSuiteStartedEvent.md) | TSS | 🟡 | -| Verdict | [EiffelConfidenceLevelModifiedEvent](https://github.com/eiffel-community/eiffel/blob/master/eiffel-vocabulary/EiffelConfidenceLevelModifiedEvent.md) | CLM | 🟤 | -| Verdict | [EiffelIssueVerifiedEvent](https://github.com/eiffel-community/eiffel/blob/master/eiffel-vocabulary/EiffelIssueVerifiedEvent.md) | IV | 🟤 | +| Category | Name | Abbreviation | Color | +|:-------------|:---------------------------------------------------------------------------------------------------------------------------|:------------:|:-----:| +| Activity | [EiffelActivityCanceledEvent](../eiffel-vocabulary/EiffelActivityCanceledEvent.md) | ActC | 🔵 | +| Activity | [EiffelActivityFinishedEvent](../eiffel-vocabulary/EiffelActivityFinishedEvent.md) | ActF | 🔵 | +| Activity | [EiffelActivityStartedEvent](../eiffel-vocabulary/EiffelActivityStartedEvent.md) | ActS | 🔵 | +| Activity | [EiffelActivityTriggeredEvent](../eiffel-vocabulary/EiffelActivityTriggeredEvent.md) | ActT | 🔵 | +| Artifact | [EiffelArtifactCreatedEvent](../eiffel-vocabulary/EiffelArtifactCreatedEvent.md) | ArtC | 🔴 | +| Artifact | [EiffelArtifactPublishedEvent](../eiffel-vocabulary/EiffelArtifactPublishedEvent.md) | ArtP | 🔴 | +| Artifact | [EiffelArtifactReusedEvent](../eiffel-vocabulary/EiffelArtifactReusedEvent.md) | ArtR | 🔴 | +| Definition | [EiffelFlowContextDefinedEvent](../eiffel-vocabulary/EiffelFlowContextDefinedEvent.md) | FCD | 🟣 | +| Definition | [EiffelCompositionDefinedEvent](../eiffel-vocabulary/EiffelCompositionDefinedEvent.md) | CD | 🟣 | +| Definition | [EiffelEnvironmentDefinedEvent](../eiffel-vocabulary/EiffelEnvironmentDefinedEvent.md) | ED | 🟣 | +| Definition | [EiffelIssueDefinedEvent](../eiffel-vocabulary/EiffelIssueDefinedEvent.md) | ID | 🟣 | +| Notification | [EiffelAnnouncementPublishedEvent](../eiffel-vocabulary/EiffelAnnouncementPublishedEvent.md) | AnnP | 🟠 | +| Source | [EiffelSourceChangeCreatedEvent](../eiffel-vocabulary/EiffelSourceChangeCreatedEvent.md) | SCC | 🟢 | +| Source | [EiffelSourceChangeSubmittedEvent](../eiffel-vocabulary/EiffelSourceChangeSubmittedEvent.md) | SCS | 🟢 | +| Test | [EiffelTestCaseCanceledEvent](../eiffel-vocabulary/EiffelTestCaseCanceledEvent.md) | TCC | 🟡 | +| Test | [EiffelTestCaseFinishedEvent](../eiffel-vocabulary/EiffelTestCaseFinishedEvent.md) | TCF | 🟡 | +| Test | [EiffelTestCaseStartedEvent](../eiffel-vocabulary/EiffelTestCaseStartedEvent.md) | TSS | 🟡 | +| Test | [EiffelTestCaseTriggeredEvent](../eiffel-vocabulary/EiffelTestCaseTriggeredEvent.md) | TCT | 🟡 | +| Test | [EiffelTestExecutionRecipeCollectionCreatedEvent](../eiffel-vocabulary/EiffelTestExecutionRecipeCollectionCreatedEvent.md) | TERCC | 🟡 | +| Test | [EiffelTestSuiteFinishedEvent](../eiffel-vocabulary/EiffelTestSuiteFinishedEvent.md) | TSF | 🟡 | +| Test | [EiffelTestSuiteStartedEvent](../eiffel-vocabulary/EiffelTestSuiteStartedEvent.md) | TSS | 🟡 | +| Verdict | [EiffelConfidenceLevelModifiedEvent](../eiffel-vocabulary/EiffelConfidenceLevelModifiedEvent.md) | CLM | 🟤 | +| Verdict | [EiffelIssueVerifiedEvent](../eiffel-vocabulary/EiffelIssueVerifiedEvent.md) | IV | 🟤 | From fc7fda33f829fc40251d2ad046be54f96f3a4282 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mattias=20Linn=C3=A9r?= <54929896+m-linner-ericsson@users.noreply.github.com> Date: Fri, 7 Oct 2022 17:01:21 +0200 Subject: [PATCH 8/8] Update tox.ini --- tox.ini | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/tox.ini b/tox.ini index f3dec769..aadab5c6 100644 --- a/tox.ini +++ b/tox.ini @@ -29,8 +29,7 @@ basepython = python3 [testenv:black] deps = - black==22.6.0 - + black==22.6.0 commands = black --check --diff . [testenv:flake8]