Skip to content

Fix docs for data invariant & remove tuple header #2811

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Aug 22, 2018
Merged

Fix docs for data invariant & remove tuple header #2811

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f08773b
Amend DATA_INVARIANT docs
Aug 22, 2018
e37e9b8
Remove unneeded header
Aug 22, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions src/util/invariant.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,6 @@ Author: Martin Brain, [email protected]
#include <cstdlib>
#include <stdexcept>
#include <string>
#include <tuple>
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Procedural nit-pick: do this in a separate commit. Possibly even a separate pull request.

Copy link
Contributor Author

@sonodtt sonodtt Aug 22, 2018 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done. In future - separate PR.

#include <type_traits>

/*
Expand Down Expand Up @@ -376,7 +375,7 @@ invariant_violated_string(

// This condition should be used to document that assumptions that are
// made on goto_functions, goto_programs, exprts, etc. being well formed.
// "The data structure is corrupt or malformed"
// "The data structure is not corrupt or malformed"
#define DATA_INVARIANT2(CONDITION, REASON) INVARIANT2(CONDITION, REASON)
#define DATA_INVARIANT3(CONDITION, REASON, DIAGNOSTICS) \
INVARIANT3(CONDITION, REASON, DIAGNOSTICS)
Expand Down