Skip to content

Commit 40fdf4a

Browse files
committed
Fixed readme URL typo. Updated root lib.rs module doc comment
1 parent 59e671a commit 40fdf4a

File tree

2 files changed

+7
-1
lines changed

2 files changed

+7
-1
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ extern crate inkwell;
4141

4242
## Documentation
4343

44-
Documenation is automatically deployed [here](https://thedan64.github.io/inkwel/) based on master. These docs are not yet 100% complete and only show the latest supported LLVM version due to a rustdoc issue. See [#2](https://github.com/TheDan64/inkwell/issues/2) for more info.
44+
Documenation is automatically deployed [here](https://thedan64.github.io/inkwell/) based on master. These docs are not yet 100% complete and only show the latest supported LLVM version due to a rustdoc issue. See [#2](https://github.com/TheDan64/inkwell/issues/2) for more info.
4545

4646
## Examples
4747

src/lib.rs

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
//! Inkwell documentation is a work in progress.
2+
//!
3+
//! If you have any LLVM knowledge that could be used to improve these docs, we would grealy appreciate you opening an issue and/or a pull request on our [GitHub page](https://github.com/TheDan64/inkwell).
4+
//!
5+
//! Due to a rustdoc issue, this documentation represents only the latest supported LLVM version. We hope that this issue will be resolved in the future so multiple versions can be documented side by side.
6+
17
#![deny(missing_debug_implementations)]
28
extern crate either;
39
#[macro_use]

0 commit comments

Comments
 (0)