Pode icon indicating copy to clipboard operation
Pode copied to clipboard

Better WebEvent Documentation

Open Viajaz opened this issue 3 years ago • 2 comments

Describe the Change

The documentation for WebEvent should be more extensive and cover more than just the first depth of the object (Eg: how are those hashtables, like Route, structured?)

WebEvent is difficult to debug (https://github.com/Badgerati/Pode/discussions/783) and it's contents can recurse making it difficult to dump.

Viajaz avatar Jun 23 '22 04:06 Viajaz

Hi @Viajaz,

For objects like the Route, their structure is defined on the Routes page. To prevent duplicating definitions in multiple places, I could add links from the WebEvent page to the relevant pages where the object is defined. Then where possible, for the likes of Request/Response say, we can update the page with their properties.

Badgerati avatar Jun 23 '22 19:06 Badgerati

Seems like all that might need to be done then is some links to those pages/anchors.

Viajaz avatar Jun 24 '22 03:06 Viajaz