Update public API docstrings to align with the style guidelines (#84)

This is a port of the style changes made to the SDK docs in the docs repository as part of the review cycle in: https://github.com/salesforcedocs/salesforce-functions/pull/183

GUS-W-12477898.

This is a port/sync of the style changes made to the SDK docs in the docs repository as part of the review cycle in: https://github.com/salesforcedocs/salesforce-functions/pull/183

GUS-W-12477898.

Remove target Python version from the Black configuration (#83)

Since it's redundant as of Black 23.1.0 (#81): https://github.com/psf/black/releases/tag/23.1.0

Update user-facing error and CLI messages to align with the style guidelines (#78)

The CX team has very kindly offered to review all user facing error and CLI messages.

This PR originally contained a script to dump all messages to a markdown file for easier review, which has been removed now that the review and messaging changes have taken place.

In addition to updating several of the messages, this PR adds project.toml files to several of the existing test fixtures, which allows them to now be run against the CLI. (Previously those testcases would only work when run against individual function validation steps as part of the unit tests, however it's useful to be able to fall back to running the testcases directly with the CLI too.)

GUS-W-12442542. GUS-W-12477495.

Update public API docstrings to align with the style guidelines

This is a port of the style changes made to the SDK docs in the docs repository as part of the review cycle in: https://github.com/salesforcedocs/salesforce-functions/pull/183

GUS-W-12477898.

Fix grammar

The CX team has very kindly offered to review all user facing error and CLI messages.

This PR originally contained a script to dump all messages to a markdown file for easier review, which has been removed now that the review and messaging changes have taken place.

In addition to updating several of the messages, this PR adds project.toml files to several of the existing test fixtures, which allows them to now be run against the CLI. (Previously those testcases would only work when run against individual function validation steps as part of the unit tests, however it's useful to be able to fall back to running the testcases directly with the CLI too.)

GUS-W-12442542. GUS-W-12477495.

Update user-facing error and CLI messages to align with the style guidelines (#78)

The CX team has very kindly offered to review all user facing error and CLI messages.

This PR originally contained a script to dump all messages to a markdown file for easier review, which has been removed now that the review and messaging changes have taken place.

In addition to updating several of the messages, this PR adds project.toml files to several of the existing test fixtures, which allows them to now be run against the CLI. (Previously those testcases would only work when run against individual function validation steps as part of the unit tests, however it's useful to be able to fall back to running the testcases directly with the CLI too.)

GUS-W-12442542. GUS-W-12477495.

Remove target Python version from the Black configuration (#83)

Since it's redundant as of Black 23.1.0 (#81): https://github.com/psf/black/releases/tag/23.1.0

Since it's redundant as of Black 23.1.0 (#81): https://github.com/psf/black/releases/tag/23.1.0

This is a port/sync of the style changes made to the SDK docs in the docs repository as part of the review cycle in: https://github.com/salesforcedocs/salesforce-functions/pull/183

GUS-W-12477898.

Enable some globally disabled pylint rules (#76)

By renaming app to asgi_app to fix redefined-outer-name, and for too-many-instance-attributes moving it to be a line-specific disable instead of being disabled globally.

Also adds tests/__init__.py to resolve an import related pylint warning that only shows up in the IDE (after #75), and not the CLI/CI. (Presumably due to the way the IDE plugin runs pylint when linting a single file.)

Make mock_event generate a unique event ID each time it is called (#77)

Previously the ID was generated at import time and then would not change from one invocation to the next.

Moving the uuid4() call out of the function signature also has the benefit that the UUID string doesn't appear in the auto-generated docs, which was causing the generated content to change every time the docs tool was run.

GUS-W-12442238.

Add missing change type headings to CHANGELOG (#79)

Since it's meant to be in the Keep a Changelog style: https://keepachangelog.com/en/1.0.0/

Bump pylint from 2.15.10 to 2.16.0 (#82)

Bumps pylint from 2.15.10 to 2.16.0.

• Release notes
• Commits

updated-dependencies:

• dependency-name: pylint dependency-type: direct:production update-type: version-update:semver-minor ...

Signed-off-by: dependabot[bot] support@github.com Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

Bump black from 22.12.0 to 23.1.0 (#81)

Bumps black from 22.12.0 to 23.1.0.

• Release notes
• Changelog
• Commits

updated-dependencies:

• dependency-name: black dependency-type: direct:production update-type: version-update:semver-major ...

Signed-off-by: dependabot[bot] support@github.com Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

Bump isort[colors] from 5.11.4 to 5.12.0 (#80)

Bumps isort[colors] from 5.11.4 to 5.12.0.

• Release notes
• Changelog
• Commits

updated-dependencies:

• dependency-name: isort[colors] dependency-type: direct:production update-type: version-update:semver-minor ...

Signed-off-by: dependabot[bot] support@github.com Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

User-facing success/error messages review

This is not for merging as-is, but is for the purpose of more easily allowing all user facing success and error messages to be reviewed by the documentation team.

See user-facing-messages.md which was generated by running the included script.

GUS-W-12442542.

Add CLI help text too

Apply review suggestions & regenerate rendered output

Remove redundant/invalid testcase

Fix testcases that didn't have a project.toml file

Apply second review suggestions and regenerate rendered output

Remove script and rendered messages

Since they were only for review.

If we need them again, we can fish them out of the PR history.

Add CHANGELOG entry

Apply second review suggestions and regenerate rendered output

Thank you for the second review.

It's not actually too bad for this PR - I was able to just run the script again (it only takes 10 seconds or so).

@jshackell-sfdc I've addressed all of the review comments except those where I commented otherwise, in: https://github.com/heroku/sf-functions-python/pull/78/commits/af241266d7e8d63105a32cb80dc05a6d26277538

However, I noticed that the rendered output you reviewed actually had the wrong error message for a few of the testcases - it had lots of duplicates of the "Didn't find a project.toml` error variant, rather than the intended message for that testcase. The reason for this was that in the unit tests these testcases exercise the individual validation functions (so don't need to pass all the other checks), but when run via the CLI the other checks error out before we even get to the error message they were meant to test.

I've fixed those testcases now, so they can be run via the CLI too - and then regenerated the rendered output. Would you be able to review these messages too? GitHub allows commenting on commits too, so to save having to sift through the whole file again, I would comment directly on here: https://github.com/heroku/sf-functions-python/pull/78/commits/34eb3e1367088650b1e2943261166a7e16653832#diff-49f7f0472fc1a7580b6d3bec7bf1e86d8f71f7b3ca0962a2de9785911371948f

Remove redundant/invalid testcase

Fix testcases that didn't have a project.toml file

Apply review suggestions & regenerate rendered output