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

Poorly documented, library code broken, please step it up. #170

Closed
fxfactorial opened this issue Sep 18, 2019 · 2 comments
Closed

Poorly documented, library code broken, please step it up. #170

fxfactorial opened this issue Sep 18, 2019 · 2 comments

Comments

@fxfactorial
Copy link

fxfactorial commented Sep 18, 2019

This library is surprisingly poorly documented, no examples around at all. I have to dig in the source code, this defeats the whole purpose of having a library and I have no idea the structs represent.

type CreateIncidentOptions struct {
	Type             string        `json:"type"`
	Title            string        `json:"title"`
	Service          *APIReference `json:"service"`
	Priority         *APIReference `json:"priority,omitempty"`
	IncidentKey      string        `json:"incident_key,omitempty"`
	Body             *APIDetails   `json:"body,omitempty"`
	EscalationPolicy *APIReference `json:"escalation_policy,omitempty"`
}

What is an APIReference? or an APIDetail? No examples.

EDIT: Searched in other people's code repos and now get the same error as mentioned in this ticket #165, the fix of which was done eight days ago.

@fxfactorial fxfactorial changed the title Poorly documented, please step it up. Poorly documented, library code broken, please step it up. Sep 18, 2019
@stmcallister
Copy link
Contributor

Sorry about the delay on this! Fix #165 has been merged.

Also, thank you for the feedback on samples. I agree. :) I've been fumbling around the source code myself to figure out how things work, which isn't how it should be. I'll make sure we get some samples posted in a repo soon.

@fxfactorial
Copy link
Author

Thank you, appreciate the response. I will try this later today and ping back if more issues.

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

No branches or pull requests

2 participants