Skip to content

Replace "entry" with "element" in function docs #4289

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

owen-mc-diffblue
Copy link
Contributor

"Entry" has a specific meaning in this file, because of entryt. The
function docs for object_map_dt use it to mean an element in a map.
Change them to use "element" instead.

  • Each commit message has a non-empty body, explaining why the change was made.
  • Methods or procedures I have added are documented, following the guidelines provided in CODING_STANDARD.md.
  • The feature or user visible behaviour I have added or modified has been documented in the User Guide in doc/cprover-manual/
  • Regression or unit tests are included, or existing tests cover the modified code (in this case I have detailed which ones those are in the commit message).
  • My commit message includes data points confirming performance improvements (if claimed).
  • My PR is restricted to a single feature or bugfix.
  • White-space or formatting changes outside the feature-related changed lines are in commits of their own.

"Entry" has a specific meaning in this file, because of entryt. The
function docs for object_map_dt use it to mean an element in a map.
Change them to use "element" instead.
Copy link
Contributor

@chrisr-diffblue chrisr-diffblue left a comment

Choose a reason for hiding this comment

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

I don't know this code, so someone more familiar than me should probably also take a look, but these docs changes seem reasonable to me.

@smowton smowton merged commit aecbf97 into diffblue:develop Feb 27, 2019
Copy link
Contributor

@allredj allredj left a comment

Choose a reason for hiding this comment

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

✔️
Passed Diffblue compatibility checks (cbmc commit: e5991c7).
Build URL: https://travis-ci.com/diffblue/test-gen/builds/102538204

@owen-mc-diffblue owen-mc-diffblue deleted the doc/do_not_use_entry_unless_referring_to_entryt branch February 28, 2019 09:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants