Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Better WebEvent Documentation #993

Closed
Viajaz opened this issue Jun 23, 2022 · 2 comments · Fixed by #1023
Closed

Better WebEvent Documentation #993

Viajaz opened this issue Jun 23, 2022 · 2 comments · Fixed by #1023
Assignees
Milestone

Comments

@Viajaz
Copy link

Viajaz commented Jun 23, 2022

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 (#783) and it's contents can recurse making it difficult to dump.

@Badgerati
Copy link
Owner

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.

@Viajaz
Copy link
Author

Viajaz commented Jun 24, 2022

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants