Skip to content

Commit fc21209

Browse files
authored
Merge pull request #73 from lucidsoftware/update-miscellaneous-documentation
Updated miscellaneous documentation
2 parents c8d5a63 + ec59ac9 commit fc21209

File tree

4 files changed

+8
-8
lines changed

4 files changed

+8
-8
lines changed

CONTRIBUTING.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
11
# Contributing guidelines
22

3-
Contributions should follow the [principals](../README.md#principals) of rules_scala_annex.
3+
Contributions should follow the [principles](README.md#principles) of `lucidsoftware/rules_scala`.
44

55
## Documentation
66

7-
To generate the [Stardoc](https://github.com/bazelbuild/skydoc),
7+
To generate the [Stardoc](https://github.com/bazelbuild/stardoc),
88

99
```
1010
$ ./scripts/gen-docs.sh
1111
```
1212

1313
## Formatting
1414

15-
[Buildifier](https://github.com/bazelbuild/buildtools/blob/master/buildifier) is used to format Skylark files,
15+
[Buildifier](https://github.com/bazelbuild/buildtools/blob/main/buildifier) is used to format Skylark files,
1616
and [Scalafmt](https://scalameta.org/scalafmt/) is used to format Scala files. To run them,
1717

1818
```
@@ -21,7 +21,7 @@ $ ./scripts/format.sh
2121

2222
## Maven deps
2323

24-
[rules_jvm_external](https://github.com/bazelbuild/rules_jvm_external) is used to generate maven deps. If you need to change
24+
[rules_jvm_external](https://github.com/bazel-contrib/rules_jvm_external) is used to generate maven deps. If you need to change
2525
dependencies, modify `maven_install` in the following different `workspace.bzl` files
2626

2727
```

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -139,6 +139,6 @@ scala_library(
139139

140140
## Further Documentation
141141

142-
See [contributing guidlines](CONTRIBUTING.md) for help on contributing to this project.
142+
See [contributing guidelines](CONTRIBUTING.md) for help on contributing to this project.
143143

144144
For all rules and attributes, see the [Stardoc](docs/stardoc).

docs/newdocs/macros.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
Using [ijar](https://github.com/bazelbuild/bazel/tree/master/third_party/ijar) poses a challenge in Scala because Scala macros are resolved during compilation. If a Scala macro references methods stripped away by ijar, things break.
44
However, forgoing `ijar` use altogether is sub-optimal---using `ijar` dramatically decreases unnecessary recompilation between builds.
55

6-
`higherkindness/rules_scala` strives to optimally integrate `ijar` and Scala macros as follows:
6+
`lucidsoftware/rules_scala` strives to optimally integrate `ijar` and Scala macros as follows:
77

88
1. `scala_library`, `scala_binary`, and `scala_test` have a Boolean `macro` attribute which must be set to true if the rule contains any Scala macros
99
2. During the classpath resolution phase, we set `macro_classpath` to contain the transitive runtime classpaths of all `deps` for which `macro = true`
@@ -12,4 +12,4 @@ However, forgoing `ijar` use altogether is sub-optimal---using `ijar` dramatical
1212
* If `macro` was true, we get problematic ijars; however, this won't be an issue:
1313
4. During compilation, we have `macro_classpath` precede the compile classpath of the merged `JavaInfo`, forcing the compiler to use the full classes
1414

15-
This lets us make use of ijars as much as possible, without breaking things due to Scala macro usage.
15+
This lets us make use of ijars as much as possible, without breaking things due to Scala macro usage.

docs/newdocs/phases.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
## Phases
22

3-
Most rules in `higherkindness/rules_scala` are architected using phases. Phases break down the Bazel Analysis stage into logical chunks.
3+
Most rules in `lucidsoftware/rules_scala` are architected using phases. Phases break down the Bazel Analysis stage into logical chunks.
44
For example, the implementation of `scala_binary` is:
55

66
```python

0 commit comments

Comments
 (0)