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.

Sign up for GitHub

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

Jump to bottom

Fix linter issues with doc strings #485

Merged
merged 2 commits into from
Jun 2, 2022
Merged

Fix linter issues with doc strings #485

merged 2 commits into from
Jun 2, 2022
+21 −1

Conversation

michel-laterman
Copy link
Contributor

What does this PR do?

Why is it important?

Checklist

  • My code follows the style guidelines of this project
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • I have made corresponding change to the default configuration files
  • I have added tests that prove my fix is effective or that my feature works
  • I have added an entry in CHANGELOG.next.asciidoc or CHANGELOG-developer.next.asciidoc.

Author's Checklist

  • [ ]

How to test this PR locally

Related issues

Use cases

Screenshots

Logs

@michel-laterman michel-laterman added Team:Elastic-Agent-Control-Plane Label for the Agent Control Plane team Cleanup labels May 31, 2022
@michel-laterman michel-laterman requested a review from a team as a code owner May 31, 2022 17:31
@michel-laterman michel-laterman requested review from aleksmaus and michalpristas and removed request for a team May 31, 2022 17:31
@mergify
Copy link
Contributor

mergify bot commented May 31, 2022

This pull request does not have a backport label. Could you fix it @michel-laterman? 🙏
To fixup this pull request, you need to add the backport labels for the needed
branches, such as:

  • backport-v./d./d./d is the label to automatically backport to the 8./d branch. /d is the digit

NOTE: backport-skip has been added to this pull request.

@elasticmachine
Copy link
Contributor

elasticmachine commented May 31, 2022 •
edited
Loading

💚 Build Succeeded

the below badges are clickable and redirect to their specific view in the CI or DOCS
Pipeline View Test View Changes Artifacts preview preview

Expand to view the summary

Build stats

  • Start Time: 2022-06-01T19:30:44.984+0000

  • Duration: 16 min 24 sec

Test stats 🧪

Test Results
Failed 0
Passed 5973
Skipped 23
Total 5996

🤖 GitHub comments

To re-run your PR in the CI, just comment with:

  • /test : Re-trigger the build.

  • /package : Generate the packages.

  • run integration tests : Run the Elastic Agent Integration tests.

  • run end-to-end tests : Generate the packages and run the E2E Tests.

  • run elasticsearch-ci/docs : Re-trigger the docs validation. (use unformatted text in the comment!)

@elasticmachine
Copy link
Contributor

elasticmachine commented May 31, 2022 •
edited
Loading

🌐 Coverage report

Name Metrics % (covered/total) Diff
Packages 97.222% (70/72) 👍
Files 68.919% (153/222) 👍
Classes 68.694% (305/444) 👍
Methods 52.693% (851/1615) 👍
Lines 38.729% (9035/23329) 👍 0.017
Conditionals 100.0% (0/0) 💚

@michel-laterman michel-laterman mentioned this pull request May 31, 2022
Closed
aleksmaus
aleksmaus approved these changes May 31, 2022
View reviewed changes
Copy link
Member

@aleksmaus aleksmaus left a comment •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

one typo, otherwise LGTM 👍

internal/pkg/agent/storage/encrypted_disk_store.go Outdated
@@ -82,6 +85,8 @@ func (d *EncryptedDiskStore) ensureKey() error {
return nil
}

// Save will write the encrypted storage to disk.
// Specifically it will write to a .tmp file then rotate the file to the target name to ensure that an error does not get rid ov the previously written file.
Copy link
Member

@aleksmaus aleksmaus May 31, 2022 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"does not get rid ov" -> "does not corrupt the previously written file"

@michel-laterman michel-laterman merged commit 3269948 into elastic:main Jun 2, 2022
@michel-laterman michel-laterman deleted the linter-fixes branch June 2, 2022 18:36
@michalpristas
Copy link
Contributor

were you able to repro/fix linting issue?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@aleksmaus aleksmaus aleksmaus approved these changes

@michalpristas michalpristas Awaiting requested review from michalpristas michalpristas is a code owner automatically assigned from elastic/elastic-agent-control-plane

Assignees

@michel-laterman michel-laterman

Labels
backport-skip Cleanup Team:Elastic-Agent-Control-Plane Label for the Agent Control Plane team
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@michel-laterman @elasticmachine @michalpristas @aleksmaus