Skip to content
This repository has been archived by the owner on Dec 29, 2022. It is now read-only.

Misleading documentation on configuration's default values #685

Closed
joaodelgado opened this issue Jan 27, 2018 · 2 comments
Closed

Misleading documentation on configuration's default values #685

joaodelgado opened this issue Jan 27, 2018 · 2 comments

Comments

@joaodelgado
Copy link
Contributor

Some of the the default values from the README and the ones present in config module don't seem to match:

https://github.com/rust-lang-nursery/rls/blob/fb4dde72b198c8a17b2d72fbc9652daea6672c1c/src/config.rs#L139-L159

The configurations that seem to have a differente values are:

Config Documentation Implementation
cfg_test true false
workspace_mode false true
@joaodelgado
Copy link
Contributor Author

joaodelgado commented Jan 29, 2018

I can work on this issue and update the documentation.

But I would also like to question the default configuration.

  • cfg_test seems very useful when writing tests.
  • As for workspace_mode, the readme states that it is still experimental and requires unstable_features, so it feels a bit weird to be enabled by default.

joaodelgado added a commit to joaodelgado/rls that referenced this issue Jan 30, 2018
@nrc
Copy link
Member

nrc commented Jan 30, 2018

The code is right in both cases - setting cfg_test to true gives a whole bunch of erroneous dead code warnings, so should be off. workspace_mode is no longer unstable and is now on by default - the documentation about it being experimental is out of date.

bors added a commit that referenced this issue Jan 28, 2019
Bump rand from 0.6.4 to 0.6.5

Bumps [rand](https://github.com/rust-random/rand) from 0.6.4 to 0.6.5.
<details>
<summary>Changelog</summary>

*Sourced from [rand's changelog](https://github.com/rust-random/rand/blob/master/CHANGELOG.md).*

> ## [0.6.5] - 2019-01-28
> ### Crates
> - Update `rand_core` to 0.4 ([#703](https://github-redirect.dependabot.com/rust-random/rand/issues/703))
> - Move `JitterRng` to its own crate ([#685](https://github-redirect.dependabot.com/rust-random/rand/issues/685))
> - Add a warm-bindgen test crate ([#696](https://github-redirect.dependabot.com/rust-random/rand/issues/696))
>
> ### Platforms
> - Fuchsia: Replaced fuchsia-zircon with fuchsia-cprng
>
> ### Doc
> - Use RFC 1946 for doc links ([#691](https://github-redirect.dependabot.com/rust-random/rand/issues/691))
> - Fix some doc links and notes ([#711](https://github-redirect.dependabot.com/rust-random/rand/issues/711))
</details>
<details>
<summary>Commits</summary>

- [`a8dc9ad`](rust-random/rand@a8dc9ad) Merge pull request [#714](https://github-redirect.dependabot.com/rust-random/rand/issues/714) from dhardy/master
- [`625411c`](rust-random/rand@625411c) Update changelog for 0.6.5
- [`76acffe`](rust-random/rand@76acffe) Merge pull request [#712](https://github-redirect.dependabot.com/rust-random/rand/issues/712) from erickt/master
- [`351edce`](rust-random/rand@351edce) Merge pull request [#711](https://github-redirect.dependabot.com/rust-random/rand/issues/711) from dhardy/master
- [`1d0d26c`](rust-random/rand@1d0d26c) Bump version, and document fuchsia_cprng change
- [`9ffaeb7`](rust-random/rand@9ffaeb7) Add rustdoc logo/root link config to sub-crates
- [`ec13800`](rust-random/rand@ec13800) Travis: allow failure of Android test
- [`b22b637`](rust-random/rand@b22b637) Fix external links in SmallRng documentation
- [`6ce5f81`](rust-random/rand@6ce5f81) Add links to the crate pages for the rngs mentioned in StdRng docs
- [`8112daa`](rust-random/rand@8112daa) Merge pull request [#703](https://github-redirect.dependabot.com/rust-random/rand/issues/703) from dhardy/master
- Additional commits viewable in [compare view](rust-random/rand@0.6.4...0.6.5)
</details>
<br />

[![Dependabot compatibility score](https://api.dependabot.com/badges/compatibility_score?dependency-name=rand&package-manager=cargo&previous-version=0.6.4&new-version=0.6.5)](https://dependabot.com/compatibility-score.html?dependency-name=rand&package-manager=cargo&previous-version=0.6.4&new-version=0.6.5)

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting `@dependabot rebase`.

[//]: # (dependabot-automerge-start)
[//]: # (dependabot-automerge-end)

---

<details>
<summary>Dependabot commands and options</summary>
<br />

You can trigger Dependabot actions by commenting on this PR:
- `@dependabot rebase` will rebase this PR
- `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it
- `@dependabot merge` will merge this PR after your CI passes on it
- `@dependabot cancel merge` will cancel a previously requested merge
- `@dependabot reopen` will reopen this PR if it is closed
- `@dependabot ignore this [patch|minor|major] version` will close this PR and stop Dependabot creating any more for this minor/major version (unless you reopen the PR or upgrade to it yourself)
- `@dependabot ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)
- `@dependabot badge me` will comment on this PR with code to add a "Dependabot enabled" badge to your readme

Additionally, you can set the following in the `.dependabot/config.yml` file in this repo:
- Update frequency (including time of day and day of week)
- Automerge options (never/patch/minor, and dev/runtime dependencies)
- Pull request limits (per update run and/or open at any time)
- Out-of-range updates (receive only lockfile updates, if desired)
- Security updates (receive only security updates, if desired)

Finally, you can contact us by mentioning @dependabot.

</details>
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

2 participants