bcgov / bcgov/tier1-pattern-test

docs: update greet() description to match current behaviour

Open
#4 0 comments 0 reactions 0 assignees View on GitHub
agentic-workflows
Dominant language
JavaScript
Stars
0
Forks
0
PR merge metrics
No merged PRs in 30d

Description

## Docs drift detected

`docs/overview.md` was out of sync with `src/hello.js`.

### What changed

| File | Before | After |
|------|--------|-------|
| `docs/overview.md` | "returns a greeting string" | Documents the actual return format and default parameter |

### Details

`src/hello.js` exports:
```js
export function greet(name = "world") {
return `Bonjour, ${name}!`;
}
```

The docs did not describe:
- The default parameter value (`"world"`)
- The actual return format (`` `Bonjour, ${name}!` ``)
- Usage examples

This PR updates `docs/overview.md` with accurate, minimal documentation matching the current implementation.

---
*Opened automatically by Tier 1 docs-drift check.*

> Generated by [Tier 1 / Docs drift (gh-aw)](https://github.com/bcgov/tier1-pattern-test/actions/runs/30791488609) · 22 AIC · ⌖ 4.88 AIC · ⊞ 5.1K · [◷](https://github.com/search?q=repo%3Abcgov%2Ftier1-pattern-test+%22gh-aw-workflow-id%3A+tier1-docs-drift%22&type=pullrequests)

---

> [!NOTE]
> This was originally intended as a pull request, but GitHub Actions is not permitted to create or approve pull requests in this repository.
> The changes have been pushed to branch `docs/fix-greet-description-bde8bad37579cbff`.
>
> **[Click here to create the pull request](https://github.com/bcgov/tier1-pattern-test/compare/main...docs/fix-greet-description-bde8bad37579cbff?expand=1&title=docs%3A%20update%20greet()%20description%20to%20match%20current%20behaviour)**

To fix the permissions issue, go to **Settings** → **Actions** → **General** and enable **Allow GitHub Actions to create and approve pull requests**. See also: [gh-aw FAQ](https://github.github.com/gh-aw/reference/faq/#why-is-my-create-pull-request-workflow-failing-with-github-actions-is-not-permitted-to-create-or-approve-pull-requests)

Show patch (37 lines)

```diff
From 4aad32efc12b3adbdb6f5ff7acaa77c329be906e Mon Sep 17 00:00:00 2001
From: "github-actions[bot]"
Date: Mon, 3 Aug 2026 06:52:14 +0000
Subject: [PATCH] docs: update greet() description to match current behaviour

- Document default parameter name = "world"
- Describe actual return format: Bonjour, ${name}!
- Add usage examples

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
---
docs/overview.md | 11 +++++++++--
1 file changed, 9 insertions(+), 2 deletions(-)

diff --git a/docs/overview.md b/docs/overview.md
index baa0f7d..d960ace 100644
--- a/docs/overview.md
+++ b/docs/overview.md
@@ -1,5 +1,12 @@
# Overview

-`greet(name)` returns a greeting string.
+`greet(name = "world")` returns a French greeting string in the format `Bonjour, ${name}!`.

-(Intentionally simple — change `src/hello.js` without updating this file to exercise docs drift.)
+**Example:**
+
+```js
+import { greet } from "./src/hello.js";
+
+greet(); // "Bonjour, world!"
+greet("Alice"); // "Bonjour, Alice!"
+```
--
2.54.0

```

Contributor guide

No contributing guide indexed for this repository

Research direction

Read docs/overview.md alongside src/hello.js to compare the documented greet() behavior with the current implementation. Confirm the default parameter, return format, and usage examples are accurately documented, then verify the documentation matches the shown behavior.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.