-
Notifications
You must be signed in to change notification settings - Fork 36
Add tests for xmagics #138
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
clang-tidy review says "All clean, LGTM! 👍" |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #138 +/- ##
==========================================
+ Coverage 75.08% 79.31% +4.22%
==========================================
Files 17 17
Lines 602 609 +7
Branches 59 59
==========================================
+ Hits 452 483 +31
+ Misses 150 126 -24 |
clang-tidy review says "All clean, LGTM! 👍" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGMT!
clang-tidy review says "All clean, LGTM! 👍" |
1 similar comment
clang-tidy review says "All clean, LGTM! 👍" |
clang-tidy review says "All clean, LGTM! 👍" |
test/test_interpreter.cpp
Outdated
/** | ||
* @class StreamRedirectRAII | ||
* @brief A RAII class to redirect a stream to a stringstream. | ||
* | ||
* This class redirects the output of a given std::ostream to a std::stringstream. | ||
* The original stream is restored when the object is destroyed. | ||
*/ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
/** | |
* @class StreamRedirectRAII | |
* @brief A RAII class to redirect a stream to a stringstream. | |
* | |
* This class redirects the output of a given std::ostream to a std::stringstream. | |
* The original stream is restored when the object is destroyed. | |
*/ | |
/// A RAII class to redirect a stream to a stringstream. | |
/// | |
/// This class redirects the output of a given std::ostream to a std::stringstream. | |
/// The original stream is restored when the object is destroyed. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I've been used to this style of doxygen comments from llvm. Probably easier when building doxygen documentation one day in terms of configuration, etc. I did not find a lot of API documentation in the xeus-cpp, so maybe we should establish that style here...
test/test_interpreter.cpp
Outdated
} | ||
|
||
private: | ||
std::streambuf* old_stream_buff; ///< The original buffer of the stream. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
std::streambuf* old_stream_buff; ///< The original buffer of the stream. | |
/// The original buffer of the stream. | |
std::streambuf* old_stream_buff; |
Documenting the public api is generally enough as the expectation is that the private api will vary over time more and will more likely cause the documentation to go out of sync.
clang-tidy review says "All clean, LGTM! 👍" |
No description provided.