Skip to content

Commit dec0eb4

Browse files
committed
docs: minor refinements
1 parent c35b7c8 commit dec0eb4

1 file changed

Lines changed: 5 additions & 5 deletions

File tree

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ Moreover, the results comprise the (LaTeX) tables that are part of our paper and
6363

6464
### Documentation
6565

66-
DiffDetective's code base is documented with javadoc and can be accessed on this [website][documentation]. Interesting classes of our library are:
66+
DiffDetective is documented with javadoc. The documentation can be accessed on this [website][documentation]. Notable classes of our library are:
6767
- [DiffTree](https://variantsync.github.io/DiffDetective/docs/javadoc/org/variantsync/diffdetective/diff/difftree/DiffTree.html) and [DiffNode](https://variantsync.github.io/DiffDetective/docs/javadoc/org/variantsync/diffdetective/diff/difftree/DiffNode.html) implement variation tree diffs from our paper. A variation tree diff is represented by an instance of the `DiffTree` class. It stores the root node of the diff and offers various methods to parse, traverse, and analyze variation tree diffs. `DiffNode`s represent individual nodes within a variation tree diff.
6868
- [Validation](https://variantsync.github.io/DiffDetective/docs/javadoc/org/variantsync/diffdetective/validation/Validation.html) contains the main method for our validation.
6969
- [ProposedElementaryPatterns](https://variantsync.github.io/DiffDetective/docs/javadoc/org/variantsync/diffdetective/pattern/elementary/proposed/ProposedElementaryPatterns.html) holds the catalog of nine edit patterns we proposed in our paper. It implements the interface [ElementaryPatternCatalogue](https://variantsync.github.io/DiffDetective/docs/javadoc/org/variantsync/diffdetective/pattern/elementary/ElementaryPatternCatalogue.html), which allows to define custom pattern catalogs.
@@ -76,7 +76,7 @@ DiffDetective's code base is documented with javadoc and can be accessed on this
7676
Our [appendix][appendix] consists of:
7777
1. An extended formalization of our concepts in the [Haskell][haskell] programming language. The corresponding source code is also part of this replication package (see below).
7878
2. The proofs for (a) the completeness of variation tree diffs to represent edits to variation trees, and (b) the completeness and unambiguity of our elementary edit patterns.
79-
3. An inspection of edit patterns from related work to show that existing patterns are either composite patterns built from our elementary patterns or similar to our elementary patterns.
79+
3. An inspection of edit patterns from related work to show that existing patterns are either composite patterns built from our elementary patterns or similar to our elementary patterns. The used diffs of these patterns can also be found in [docs/compositepatterns](docs/compositepatterns).
8080
4. The complete results of our validation for all 44 datasets.
8181

8282
## 3. Haskell Formalization
@@ -95,7 +95,7 @@ We provide updated links for each system's repository.
9595
### 4.2 Forked Repositories for Replication
9696
To guarantee the exact replication of our validation, we created forks of all 44 open-source repositories at the state we performed the validation for our paper.
9797
The forked repositories are listed in the [replication datasets](docs/replication/datasets.md) and are located at the Github user profile [DiffDetective](https://github.com/DiffDetective?tab=repositories).
98-
These repositories are used when running the replication as described under `1.2`.
98+
These repositories are used when running the replication as described under `1.2` and in the [INSTALL](INSTALL.md).
9999

100100
## 5. Running DiffDetective on Custom Datasets
101101
You can also run DiffDetective on other datasets by providing the path to the dataset file as first argument to the execution script:
@@ -107,14 +107,14 @@ You can also run DiffDetective on other datasets by providing the path to the da
107107

108108
The input file must have the same format as the other dataset files (i.e., repositories are listed in a Markdown table). You can find [dataset files](docs/datasets.md) in the [docs](docs) folder.
109109

110-
[difftree_class]: src/main/java/org/variantsync/diffdetective/diff/difftree/DiffTree.java
110+
[difftree_class]: https://variantsync.github.io/DiffDetective/docs/javadoc/org/variantsync/diffdetective/diff/difftree/DiffTree.html
111111
[haskell]: https://www.haskell.org/
112112
[dataset]: docs/datasets.md
113113
[appendix]: appendix.pdf
114114

115115
[documentation]: https://variantsync.github.io/DiffDetective/docs/javadoc/
116116
[website]: https://variantsync.github.io/DiffDetective/
117117

118-
[resultsdir]: results/validation/current
118+
[resultsdir]: results
119119
[resultsdir_classification_results]: results/validation/current/ultimateresult.metadata.txt
120120
[resultsdir_speed_statistics]: results/validation/current/speedstatistics.txt

0 commit comments

Comments
 (0)