bcgov / bcgov/tier1-pattern-test
docs: fix docs drift — document greet() French greeting format and defaults
- Dominant language
- JavaScript
- Stars
- 0
- Forks
- 0
- PR merge metrics
- No merged PRs in 30d
Description
## What drifted
`src/hello.js` exports `greet(name = "world")` which returns `"Bonjour, !"` — a French greeting with a specific format and a default parameter.
`docs/overview.md` only said _"returns a greeting string"_, omitting:
- The **French** greeting format (`Bonjour,` not `Hello`)
- The **default parameter** value (`"world"`)
- The **exact return string** format
## Changes
Updated `docs/overview.md` to accurately describe:
- Function signature with optional `name` parameter and its default
- Return type and format
- Usage examples
## Reviewer notes
No source code was changed. This is a pure docs-only fix to close the drift detected by the Tier 1 docs-drift workflow.
> Generated by [Tier 1 / Docs drift (gh-aw)](https://github.com/bcgov/tier1-pattern-test/actions/runs/31361340115) · 22.4 AIC · ⌖ 4.9 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-drift-60beffa463b5aa86`.
>
> **[Click here to create the pull request](https://github.com/bcgov/tier1-pattern-test/compare/main...docs/fix-greet-drift-60beffa463b5aa86?expand=1&title=docs%3A%20fix%20docs%20drift%20%E2%80%94%20document%20greet()%20French%20greeting%20format%20and%20defaults)**
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 (45 lines)
```diff
From af3c2758dba8426ee376b24ed4e67f7ab86ef01a Mon Sep 17 00:00:00 2001
From: "github-actions[bot]"
Date: Mon, 10 Aug 2026 06:18:16 +0000
Subject: [PATCH] docs: update overview to match greet() actual behaviour
- Document French greeting format (Bonjour, not Hello)
- Add default parameter value ("world")
- Add return format and usage examples
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
---
docs/overview.md | 19 +++++++++++++++++--
1 file changed, 17 insertions(+), 2 deletions(-)
diff --git a/docs/overview.md b/docs/overview.md
index baa0f7d..a454943 100644
--- a/docs/overview.md
+++ b/docs/overview.md
@@ -1,5 +1,20 @@
# Overview
-`greet(name)` returns a greeting string.
+## `greet(name?)`
-(Intentionally simple — change `src/hello.js` without updating this file to exercise docs drift.)
+Returns a French greeting string.
+
+| Parameter | Type | Default | Description |
+|-----------|--------|-----------|-----------------------|
+| `name` | string | `"world"` | The name to greet |
+
+**Returns:** `string` — `"Bonjour, !"`
+
+**Example:**
+
+```js
+import { greet } from "./hello.js";
+
+greet(); // "Bonjour, world!"
+greet("Alice"); // "Bonjour, Alice!"
+```
--
2.54.0
```
Contributor guide
No contributing guide indexed for this repository
Research direction
Read the implementation in src/hello.js and compare it with docs/overview.md. Verify that the documentation covers the greet() signature, default, French return format, and examples, then confirm the existing branch changes are complete.
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
- 25/100