docs: add comment to IsAllowed function in bitbucketdatacenter#2060
Closed
docs: add comment to IsAllowed function in bitbucketdatacenter#2060
Conversation
- really to test CI - Added explanatory comment to clarify the purpose of IsAllowed function - Improved code documentation for better readability and maintenance Signed-off-by: Chmouel Boudjnah <chmouel@redhat.com>
Deploying pipelines-as-code with
|
| Latest commit: |
d1db8eb
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://59b563dd.pipelines-as-code.pages.dev |
| Branch Preview URL: | https://startpaac2.pipelines-as-code.pages.dev |
Contributor
There was a problem hiding this comment.
Pull Request Overview
A PR that improves code documentation by adding an explanatory comment to the IsAllowed function in the Bitbucket Data Center provider.
- Added a documentation comment for the IsAllowed function to clarify its purpose.
- Improved overall readability of the code comments.
|
|
||
| type activitiesTypes struct{ Values []*bbv1.Activity } | ||
|
|
||
| // IsAllowed check if the user is allowed to trigger the pipeline. |
There was a problem hiding this comment.
[nitpick] Consider updating the comment for correct grammar. For example, change 'check' to 'checks' to read: '// IsAllowed checks if the user is allowed to trigger the pipeline.'
Suggested change
| // IsAllowed check if the user is allowed to trigger the pipeline. | |
| // IsAllowed checks if the user is allowed to trigger the pipeline. |
chmouel
force-pushed
the
startpaac2
branch
8 times, most recently
from
47c1900 to
93ac044
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Changes
Submitter Checklist
📝 Ensure your commit message is clear and informative. Refer to the How to write a git commit message guide. Include the commit message in the PR body rather than linking to an external site (e.g., Jira ticket).
♽ Run make test lint before submitting a PR to avoid unnecessary CI processing. Consider installing pre-commit and running pre-commit install in the repository root for an efficient workflow.
✨ We use linters to maintain clean and consistent code. Run make lint before submitting a PR. Some linters offer a --fix mode, executable with make fix-linters (ensure markdownlint and golangci-lint are installed).
📖 Document any user-facing features or changes in behavior.
🧪 While 100% coverage isn't required, we encourage unit tests for code changes where possible.
🎁 If feasible, add an end-to-end test. See README for details.
🔎 Address any CI test flakiness before merging, or provide a valid reason to bypass it (e.g., token rate limitations).
If adding a provider feature, fill in the following details:
(update the provider documentation accordingly)