Skip to content

Commit 2b9408b

Browse files
committed
Concepts: Add some architecture documentation
1 parent 36c4213 commit 2b9408b

File tree

3 files changed

+27
-3
lines changed

3 files changed

+27
-3
lines changed
Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,13 @@
11
/**
2-
* Provides Concepts which are shared across languages. See `Concepts.qll` for details.
2+
* Provides Concepts which are shared across languages.
3+
*
4+
* Each language will have a language specific `Concepts.qll` file that can import the
5+
* shared concepts from this file. A language can either re-export the concept directly,
6+
* or can add additional member-predicates that are needed for that language.
7+
*
8+
* Moving forward, `Concepts.qll` will be the staging ground for brand new concepts from
9+
* each language, but we will maintain a discipline of moving those concepts to
10+
* `ConceptsShared.qll` ASAP.
311
*/
412

513
private import ConceptsImports
Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,13 @@
11
/**
2-
* Provides Concepts which are shared across languages. See `Concepts.qll` for details.
2+
* Provides Concepts which are shared across languages.
3+
*
4+
* Each language will have a language specific `Concepts.qll` file that can import the
5+
* shared concepts from this file. A language can either re-export the concept directly,
6+
* or can add additional member-predicates that are needed for that language.
7+
*
8+
* Moving forward, `Concepts.qll` will be the staging ground for brand new concepts from
9+
* each language, but we will maintain a discipline of moving those concepts to
10+
* `ConceptsShared.qll` ASAP.
311
*/
412

513
private import ConceptsImports
Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,13 @@
11
/**
2-
* Provides Concepts which are shared across languages. See `Concepts.qll` for details.
2+
* Provides Concepts which are shared across languages.
3+
*
4+
* Each language will have a language specific `Concepts.qll` file that can import the
5+
* shared concepts from this file. A language can either re-export the concept directly,
6+
* or can add additional member-predicates that are needed for that language.
7+
*
8+
* Moving forward, `Concepts.qll` will be the staging ground for brand new concepts from
9+
* each language, but we will maintain a discipline of moving those concepts to
10+
* `ConceptsShared.qll` ASAP.
311
*/
412

513
private import ConceptsImports

0 commit comments

Comments
 (0)