Skip to content
This repository has been archived by the owner on Nov 6, 2020. It is now read-only.

Testing instructions missing from Readme #10655

Closed
ltfschoen opened this issue May 13, 2019 · 3 comments
Closed

Testing instructions missing from Readme #10655

ltfschoen opened this issue May 13, 2019 · 3 comments
Labels
M3-docs 📑 Documentation.

Comments

@ltfschoen
Copy link
Contributor

The Readme does not include instructions on how to run tests for an individual package and how to run tests across all the packages at once like in Substrate https://github.com/paritytech/substrate#613-shared-steps
@ltfschoen
Copy link
Contributor Author

Suggest adding in the "Documentation" section after #10652 is merged, since users may want to specify a specific package to run the tests on, and we've listed them in that section

@jam10o-new jam10o-new added the M3-docs 📑 Documentation. label May 14, 2019
@ltfschoen
Copy link
Contributor Author

Note that these are the commands that I commonly use to quickly view docs (including private doc comments) and to run tests whilst outputting logs at the same time.

cargo doc -p evmbin --no-deps --document-private-items --open
cargo test -p evmbin -- --nocapture

ltfschoen added a commit that referenced this issue Jul 3, 2019
@ltfschoen
tests: Relates to #10655: Test instructions for Readme
b36d8c4 
* Add instructions to run tests
* Update instructions to view docs
dvdplm pushed a commit that referenced this issue Jul 3, 2019
@ltfschoen @dvdplm
tests: Relates to #10655: Test instructions for Readme (#10835)
09edb94 
* tests: Relates to #10655: Test instructions for Readme

* Add instructions to run tests
* Update instructions to view docs

* fix: Fix link to package list

* fix: Move link to line about title of package list

* Update README.md
dvdplm added a commit that referenced this issue Jul 4, 2019
@dvdplm
Merge branch 'master' into dp/fix/prevent-building-block-on-top-of-sa…
95ec389 
…me-parent

* master:
  refactor: whisper: Add type aliases and update rustdocs in message.rs (#10812)
  Break circular dependency between Client and Engine (part 1) (#10833)
  tests: Relates to #10655: Test instructions for Readme (#10835)
  refactor: Related #9459 - evmbin: replace untyped json! macro with fully typed serde serialization using Rust structs (#10657)
  idiomatic changes to PodState (#10834)
  Allow --nat extip:your.host.here.org (#10830)
  When updating the client or when called from RPC, sleep should mean sleep (#10814)
  Remove excessive warning (#10831)
  Fix typo in README.md (#10828)
  ethcore does not use byteorder (#10829)
  Better logging when backfilling ancient blocks fail (#10796)
  depends: Update wordlist to v1.3 (#10823)
dvdplm added a commit that referenced this issue Jul 4, 2019
@dvdplm
Merge branch 'master' into ng-fix-fork-choice
26f80c2 
* master:
  refactor: whisper: Add type aliases and update rustdocs in message.rs (#10812)
  Break circular dependency between Client and Engine (part 1) (#10833)
  tests: Relates to #10655: Test instructions for Readme (#10835)
  refactor: Related #9459 - evmbin: replace untyped json! macro with fully typed serde serialization using Rust structs (#10657)
  idiomatic changes to PodState (#10834)
  Allow --nat extip:your.host.here.org (#10830)
  When updating the client or when called from RPC, sleep should mean sleep (#10814)
  Remove excessive warning (#10831)
  Fix typo in README.md (#10828)
  ethcore does not use byteorder (#10829)
  Better logging when backfilling ancient blocks fail (#10796)
  depends: Update wordlist to v1.3 (#10823)
  cargo update -p smallvec (#10822)
  replace memzero with zeroize crate (#10816)
  Don't repeat the logic from Default impl (#10813)
  removed additional_params method (#10818)
  Add Constantinople eips to the dev (instant_seal) config (#10809)
dvdplm added a commit that referenced this issue Jul 4, 2019
@dvdplm
Merge branch 'master' into luke-whisper-cli-test
cc45ea8 
* master: (21 commits)
  refactor: whisper: Add type aliases and update rustdocs in message.rs (#10812)
  Break circular dependency between Client and Engine (part 1) (#10833)
  tests: Relates to #10655: Test instructions for Readme (#10835)
  refactor: Related #9459 - evmbin: replace untyped json! macro with fully typed serde serialization using Rust structs (#10657)
  idiomatic changes to PodState (#10834)
  Allow --nat extip:your.host.here.org (#10830)
  When updating the client or when called from RPC, sleep should mean sleep (#10814)
  Remove excessive warning (#10831)
  Fix typo in README.md (#10828)
  ethcore does not use byteorder (#10829)
  Better logging when backfilling ancient blocks fail (#10796)
  depends: Update wordlist to v1.3 (#10823)
  cargo update -p smallvec (#10822)
  replace memzero with zeroize crate (#10816)
  Don't repeat the logic from Default impl (#10813)
  removed additional_params method (#10818)
  Add Constantinople eips to the dev (instant_seal) config (#10809)
  removed redundant fmt::Display implementations (#10806)
  revert changes to .gitlab-ci.yml (#10807)
  Add filtering capability to `parity_pendingTransactions` (issue 8269) (#10506)
  ...
dvdplm added a commit that referenced this issue Jul 4, 2019
@dvdplm
Merge branch 'master' into dp/chore/extricate-account-db-into-own-crate
b7c7aae 
* master:
  Extricate PodAccount and state Account to own crates (#10838)
  logs (#10817)
  refactor: whisper: Add type aliases and update rustdocs in message.rs (#10812)
  Break circular dependency between Client and Engine (part 1) (#10833)
  tests: Relates to #10655: Test instructions for Readme (#10835)
  refactor: Related #9459 - evmbin: replace untyped json! macro with fully typed serde serialization using Rust structs (#10657)
dvdplm added a commit that referenced this issue Jul 4, 2019
@dvdplm
Merge branch 'dp/chore/extricate-account-db-into-own-crate' into dp/c…
9553c8c 
…hore/extricate-state-backend

* dp/chore/extricate-account-db-into-own-crate:
  third time's the charm
  test failure 2
  test failure
  Extricate PodAccount and state Account to own crates (#10838)
  logs (#10817)
  refactor: whisper: Add type aliases and update rustdocs in message.rs (#10812)
  Break circular dependency between Client and Engine (part 1) (#10833)
  tests: Relates to #10655: Test instructions for Readme (#10835)
  refactor: Related #9459 - evmbin: replace untyped json! macro with fully typed serde serialization using Rust structs (#10657)
@niklasad1
Copy link
Collaborator

Closed by #10835

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
M3-docs 📑 Documentation.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@ltfschoen @niklasad1 @jam10o-new