Skip to content

Commit e73a39d

Browse files
committed
Update docs in README
1 parent c5439e6 commit e73a39d

File tree

1 file changed

+7
-6
lines changed

1 file changed

+7
-6
lines changed

README.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@ targeted item and what's in scope (which means items like `String` which are in
3333
the prelude are just a `[String]` away). Those links are clearer for both
3434
the person writing them in the first place and subsequent readers reviewing them.
3535
They are also easier to reason about since file hierachy does not affect them.
36+
Below is the intra-doc links version of the examples above:
3637

3738
```rust
3839
/// [`make_ascii_uppercase`]: u8::make_ascii_uppercase()
@@ -83,7 +84,11 @@ $ cargo intraconv path/to/my/file.rs -i intraconv.toml # Give a file containing
8384
# links to ignore
8485
```
8586

86-
It is possible to give multiple paths to files or directories.
87+
It is possible to give multiple paths to files or directories. When searching
88+
exact paths, `cargo-intraconv` will use the crate name given with `-c`. For
89+
directories it will try to find the crate name in a `Cargo.toml`, falling back
90+
to the default of `-c` if the name cannot be transformed to a valid Rust
91+
identifier.
8792

8893
> Note: `intraconv` will accept any file, no just `.rs` ones: you can use it
8994
> on markdown files that are included as docs in Rust files for example.
@@ -137,15 +142,11 @@ should be adressed in future versions of either the crate or Rust itself.
137142

138143
For issues about intra-doc links you should look-up [the issues at `rust-lang/rust`].
139144

140-
For issues about this crate, here are a few:
145+
For issues about this crate, here is one:
141146

142147
- `#method.method_name` links will sometimes be transformed to point to the
143148
wrong item. This is because `intraconv` uses regexes to find links and the
144149
types related to them, which is not perfect.
145-
- Crate names are not detected very well at the moment and if you don't use
146-
`--crate` (`-c`) will sometime fail in strange ways. Be sure to check !
147-
By default `cargo-intraconv` will use `my_krate` to avoid false `crate::`
148-
replacements.
149150

150151
[the issues at `rust-lang/rust`]: https://github.com/rust-lang/rust/issues?q=is%3Aopen+label%3AA-intra-doc-links+label%3AC-bug
151152

0 commit comments

Comments
 (0)