google / google/googletest

[Bug]: Possible Typo in gMock Documentation

Open
#4,733 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
C++
Stars
39.5k
Forks
10.9k
Avg merge
6d 13h
Merged PRs (30d)
1

Description

### Describe the issue

In docs [gMock for dummies](https://github.com/google/googletest/blob/main/docs/gmock_for_dummies.md?plain=1), line 683, here used `RetiresOnSaturation()`, which I think is not need with `InSequence`. Adding this line could mislead readers about the understanding that expectations in `InSequence` are not sticky.

![Image](https://github.com/user-attachments/assets/c5457dfe-b645-4bdf-94dd-f6cc0f36c67c)

### Steps to reproduce the problem

None.

### What version of GoogleTest are you using?

None.

### What operating system and version are you using?

None.

### What compiler and version are you using?

None.

### What build system are you using?

None.

### Additional context

_No response_

Contributor guide

Open the contributing guide

Research direction

Open docs/gmock_for_dummies.md at line 683 and review the InSequence example containing RetiresOnSaturation(). Compare the example with the issue's concern about expectations not being sticky, then update the documentation so the example is not misleading and verify the surrounding rendered text remains coherent.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.