-
Notifications
You must be signed in to change notification settings - Fork 2
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
Update API docs #10
Update API docs #10
Conversation
The rules are: - use `s` for slice argumnets - use `e` for element arguments - append index to argument names if there are multiple of them; e.g. `s1`/`s2` or `e1`/`e2`
Pull Request Test Coverage Report for Build 6656080881
💛 - Coveralls |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This PR is missing a reference to Jira ticket:
-
Jira ticket ID should be appended to the PR title
-
Jira ticket URL should be added as a list item in the Related section (
- https://planitar.atlassian.net/browse/{ID}
)
Make sure you provide links to relevant context (Jira tasks, Github issues, other PRs) as follows:
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This PR is missing a reference to Jira ticket:
-
Jira ticket ID should be appended to the PR title
-
Jira ticket URL should be added as a list item in the Related section (
- https://planitar.atlassian.net/browse/{ID}
)
Make sure you provide links to relevant context (Jira tasks, Github issues, other PRs) as follows:
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This PR is missing a reference to Jira ticket:
-
Jira ticket ID should be appended to the PR title
-
Jira ticket URL should be added as a list item in the Related section (
- https://planitar.atlassian.net/browse/{ID}
)
Make sure you provide links to relevant context (Jira tasks, Github issues, other PRs) as follows:
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This PR is missing a reference to Jira ticket:
-
Jira ticket ID should be appended to the PR title
-
Jira ticket URL should be added as a list item in the Related section (
- https://planitar.atlassian.net/browse/{ID}
)
Make sure you provide links to relevant context (Jira tasks, Github issues, other PRs) as follows:
The PR tries to make the API docs in https://pkg.go.dev/github.com/PlanitarInc/slc more consistent:
The rules are:
s
for slice argumnetse
for element argumentse.g.
s1
/s2
ore1
/e2
Overlap()
andIntersect()