fix(docs): add @throws to PHPDoc when appropriate#360
Conversation
Greptile SummaryThis PR adds Confidence Score: 5/5Safe to merge — documentation-only change with accurate @throws annotations throughout. All @throws annotations are accurate and consistent with the actual exception hierarchy. WorkOSException is an interface implemented by all throwable types; ConfigurationException is used precisely for URL-builder methods that call requireClientId(); methods that only call buildUrl() correctly have no annotation. No logic changes are present. No files require special attention. Important Files Changed
Flowchart%%{init: {'theme': 'neutral'}}%%
flowchart TD
A[Service Method] --> B{Makes HTTP request?}
B -- Yes --> C["@throws WorkOSException"]
B -- No --> D{Calls requireClientId or requireApiKey?}
D -- Yes --> E["@throws ConfigurationException"]
D -- No --> F[No @throws needed e.g. getLogoutUrl]
Reviews (1): Last reviewed commit: "fix(docs): add `@throws` to PHPDoc when ..." | Re-trigger Greptile |
|
Thanks |
Should close #356. The oagen-emitters have been modified to provide this information.