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

Update API docs #10

Merged
merged 2 commits into from
Nov 6, 2023
Merged

Update API docs #10

merged 2 commits into from
Nov 6, 2023

Conversation

korya
Copy link
Contributor

@korya korya commented Oct 26, 2023

The PR tries to make the API docs in https://pkg.go.dev/github.com/PlanitarInc/slc more consistent:

  • Update API to have consistent naming for arguments
    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
  • Add missing math meaning for more functions: Overlap() and Intersect()

korya added 2 commits October 26, 2023 10:59
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`
@korya korya requested review from flpsan and orihab October 26, 2023 15:07
@coveralls
Copy link

Pull Request Test Coverage Report for Build 6656080881

  • 70 of 70 (100.0%) changed or added relevant lines in 1 file are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 100.0%

Totals Coverage Status
Change from base Build 6655348036: 0.0%
Covered Lines: 135
Relevant Lines: 135

💛 - Coveralls

gitstream-cm[bot]
gitstream-cm bot previously requested changes Oct 26, 2023
Copy link

@gitstream-cm gitstream-cm bot left a 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:
Github integration

@korya
Copy link
Contributor Author

korya commented Nov 2, 2023

@orihab @flpsan Guys, do you have any objections?

gitstream-cm[bot]
gitstream-cm bot previously requested changes Nov 3, 2023
Copy link

@gitstream-cm gitstream-cm bot left a 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:
Github integration

@gitstream-cm gitstream-cm bot dismissed their stale review November 3, 2023 16:54

Review resolved

gitstream-cm[bot]
gitstream-cm bot previously requested changes Nov 3, 2023
Copy link

@gitstream-cm gitstream-cm bot left a 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:
Github integration

@gitstream-cm gitstream-cm bot dismissed their stale review November 3, 2023 16:55

Review resolved

@korya korya changed the title Update api docs Update API docs Nov 6, 2023
Copy link

@gitstream-cm gitstream-cm bot left a 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:
Github integration

@gitstream-cm gitstream-cm bot dismissed their stale review November 6, 2023 18:55

Review resolved

@korya korya merged commit 59df852 into master Nov 6, 2023
@korya korya deleted the update-api-docs branch November 6, 2023 18:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants