Skip to content

Fix typo in README.md from 'functional' to 'functions'#1866

Closed
michaeldiederich wants to merge 1 commit intowheels-dev:developfrom
michaeldiederich:patch-3
Closed

Fix typo in README.md from 'functional' to 'functions'#1866
michaeldiederich wants to merge 1 commit intowheels-dev:developfrom
michaeldiederich:patch-3

Conversation

@michaeldiederich
Copy link
Contributor

Notice for Filename for getting Tests running

Notice for Filename for getting Tests running
@zainforbjs
Copy link
Contributor

@michaeldiederich Just to clarify — the functional/ directory name is correct and intentional, as it represents functional tests (which in our case cover end-to-end behavior). So no change is needed there.

Also, the note added to the README is already documented in the official Wheels testing documentation. It might be worth avoiding duplication or instead referencing the existing docs to keep things consistent.

@michaeldiederich
Copy link
Contributor Author

Well, the wheels-base-template has a ExampleSpecs.cfc Test in the functions-folder and the functions-Folder is not mentioned in the documentation, so I guessed, the code is right and the documentation should be renamed. So the wheels-base-template should be renamed?

@zainforbjs
Copy link
Contributor

Thanks for clarifying!

If the functions/ folder exists in the wheels-base-template but isn’t documented, then the issue is likely that the template is out of sync with the current testing structure.
In Wheels 3.0, the intended structure is:

  • specs/unit/
  • specs/integration/
  • specs/functional/

So rather than renaming the documentation to match the template, I believe the template should be updated to reflect the documented structure. We can rename the folder from Functions to Functional.

bpamiri added a commit that referenced this pull request Feb 12, 2026
The directory was incorrectly named "functions" in the base template
and repo-level tests. The intended name is "functional", which aligns
with the README, the documented testing architecture (unit/integration/
functional), and standard framework conventions (Django, Rails).

Also updates doc references in testing-your-application.md and
using-the-test-environment.md.

Closes #1866

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@bpamiri
Copy link
Collaborator

bpamiri commented Feb 12, 2026

Thanks for catching this inconsistency @michaeldiederich! After looking into it, I agree with @zainforbjsfunctional/ is the correct name. No major framework uses functions/ as a test directory name (functional/ aligns with Django and legacy Rails conventions, while Laravel uses feature/, modern Rails uses system/, and NestJS uses e2e/). The template folder was the typo, not the README.

I've pushed the rename in #1872 which should close this issue.

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.

3 participants

Comments