Summary: | Add documentation for cypress plugins | ||
---|---|---|---|
Product: | Koha | Reporter: | Martin Renvoize (ashimema) <martin.renvoize> |
Component: | Test Suite | Assignee: | Martin Renvoize (ashimema) <martin.renvoize> |
Status: | Needs Signoff --- | QA Contact: | Testopia <testopia> |
Severity: | enhancement | ||
Priority: | P5 - low | CC: | jonathan.druart |
Version: | Main | ||
Hardware: | All | ||
OS: | All | ||
GIT URL: | Change sponsored?: | --- | |
Patch complexity: | --- | Documentation contact: | |
Documentation submission: | Text to go in the release notes: | ||
Version(s) released in: | Circulation function: | ||
Bug Depends on: | 40318 | ||
Bug Blocks: | |||
Attachments: | Bug 40447: Add comprehensive JSDoc documentation to Cypress plugins |
Description
Martin Renvoize (ashimema)
2025-07-18 10:55:16 UTC
Created attachment 184320 [details] [review] Bug 40447: Add comprehensive JSDoc documentation to Cypress plugins This patch adds detailed JSDoc documentation to all Cypress testing plugin files. Documentation added to: - insertData.js: Data insertion utilities with examples - api-client.js: API wrapper functions with usage patterns - mockData.js: Schema-based mock data generation - auth.js: Authentication helper functions - db.js: Database query utilities - readYamlFile.js: YAML file reading utilities - index.js: Main plugin configuration Each function now includes: - Complete parameter descriptions with types - Return value documentation - Practical usage examples - Error conditions and handling - Module-level overviews This addresses the documentation gap identified during QA review, hopefully making it easier for future devs to adopt the new framework of tools. |