Capture exceptions by const& in docs. #4099
Merged
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.
Hi,
The core guidelines recommend catching by
const&
for all but very small value types. One of my colleagues filed a PR internally withcatch (nlohmann::json::type_error& e)
, instead ofcatch (const nlohmann::json::type_error& e)
, with the explanation that it was copied from the documentation. The error here holds a string however, so it is not a simple type that fits in a single register, I thinkconst &
is appropriate. This PR updates the documentation's exception catching to be all const.Automated replace performed with the following command:
Pull request checklist
Read the Contribution Guidelines for detailed information.
include/nlohmann
directory, runmake amalgamate
to create the single-header filessingle_include/nlohmann/json.hpp
andsingle_include/nlohmann/json_fwd.hpp
. The whole process is described here.