google / google/caliper

[Docs] Possible outdated documentation

Open
#459 0 comments 0 reactions 0 assignees View on GitHub
component: docs P4 type=documentation
Dominant language
Java
Stars
818
Forks
112
Avg merge
12m
Merged PRs (30d)
5

Description

We have identified **`3`** possible instances of outdated documentation:

- [ ] [`MicrobenchmarkInstrument`](https://github.com/google/caliper/blob/5634acb439ed39963eea060e0a082e7120419eac/.idea/workspace.xml#L23) was deleted but the change has not been reflected in the current version of the [UnderstandingTheCodebase](https://github.com/google/caliper/wiki/UnderstandingTheCodebase/6c51070eea478a73971b9c0ad82031e85c34ea36) wiki page

- [ ] [`MicrobenchmarkWorker`](https://github.com/google/caliper/blob/5634acb439ed39963eea060e0a082e7120419eac/.idea/workspace.xml#L4) was deleted but the change has not been reflected in the current version of the [UnderstandingTheCodebase](https://github.com/google/caliper/wiki/UnderstandingTheCodebase/6c51070eea478a73971b9c0ad82031e85c34ea36) wiki page

- [ ] [`WorkerResponse`](https://github.com/google/caliper/blob/5634acb439ed39963eea060e0a082e7120419eac/.idea/workspace.xml#L13) was deleted but the change has not been reflected in the current version of the [UnderstandingTheCodebase](https://github.com/google/caliper/wiki/UnderstandingTheCodebase/6c51070eea478a73971b9c0ad82031e85c34ea36) wiki page

#### About
This is part of a research project that aims to automatically detect outdated documentation in GitHub repositories. We are evaluating the validity of our approach by identifying instances of outdated documentation in real-world projects.

We hope that this research will be a step towards keeping documentation up-to-date. If this has been helpful, consider updating the documentation to keep it in sync with the source code. If this has not been helpful, consider updating this issue with an explanation, so that we can improve our approach. Thanks!

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.