Pass extra arguments onwards #10
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
It's documented that one can pass any further options, but these weren't passed on and thus always ignored.
|
Thanks! I think this deserves a |
scrabsha
pushed a commit
that referenced
this pull request
Nov 22, 2021
In previous implementation, there was a `dep_doc` (resp. `dev_dep_doc`
macro, which expanded to the concatenation of the following:
- the beginning of a code snippet with the section `[dependencies]`
(resp. `[dev-dependencies])`,
- a call to package_import with the correct package name and version
passed as argument,
- the ned of the code snippet.
The problem with this approach is that it was not possible to test the
complete expansion of a macro, given a crate name, a version and some
other information. This even resulted to a bug where we forgot to pass
the so called "other information" to the package_import. See #10 for
more.
This commit allows for simple testing by adding an additional
intermediate step. The `dep_doc` (resp. `dev_dep_doc`) macro now expands
to a call to `dep_doc_inner` (resp. `dev_dep_doc_inner`), with the crate
name and version guessed from the environment and the
"other information". `dep_doc_inner` (resp. `dev_dep_doc`) is then
responsible for generating the concatenation described previously.
As such, most of the expansion process can be tested by calling
`dep_doc_inner` (resp. `dev_dep_doc_inner`).
scrabsha
added a commit
that referenced
this pull request
Nov 22, 2021
In previous implementation, there was a `dep_doc` (resp. `dev_dep_doc`
macro, which expanded to the concatenation of the following:
- the beginning of a code snippet with the section `[dependencies]`
(resp. `[dev-dependencies])`,
- a call to package_import with the correct package name and version
passed as argument,
- the ned of the code snippet.
The problem with this approach is that it was not possible to test the
complete expansion of a macro, given a crate name, a version and some
other information. This even resulted to a bug where we forgot to pass
the so called "other information" to the package_import. See #10 for
more.
This commit allows for simple testing by adding an additional
intermediate step. The `dep_doc` (resp. `dev_dep_doc`) macro now expands
to a call to `dep_doc_inner` (resp. `dev_dep_doc_inner`), with the crate
name and version guessed from the environment and the
"other information". `dep_doc_inner` (resp. `dev_dep_doc`) is then
responsible for generating the concatenation described previously.
As such, most of the expansion process can be tested by calling
`dep_doc_inner` (resp. `dev_dep_doc_inner`).
A bunch of tests have been added in the process in order to ensure that
the previously linked bug won't happen again.
Merged
scrabsha
pushed a commit
that referenced
this pull request
Nov 22, 2021
This release allows us to publish a fix merged in #10.
scrabsha
added a commit
that referenced
this pull request
Nov 22, 2021
This release allows us to publish a fix merged in #10. The expansion has been rearranged along the way in order to make it easier to test.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
It's documented that one can pass any further options,
but these weren't passed on and thus always ignored.
Thank you for this crate!