-
Notifications
You must be signed in to change notification settings - Fork 189
docs: enhance FeeAssessmentMethod enum docstring #1393
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
Changes from 2 commits
3c6d67a
72b1af3
2667e60
c2365e7
1177c49
5afc0bd
e4170b0
f12c689
9ef922c
92c9aa0
49793e5
61bbbdb
5380884
4f286a4
b8f2842
d676b4b
778ca9a
dc7d909
325c861
421a4dc
1943d55
da93ce6
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,4 +1,4 @@ | ||
| # Changelog | ||
| # Changelog | ||
|
|
||
| All notable changes to this project will be documented in this file. | ||
| This project adheres to [Semantic Versioning](https://semver.org). | ||
|
|
@@ -7,6 +7,7 @@ This changelog is based on [Keep a Changelog](https://keepachangelog.com/en/1.1. | |
| ## [Unreleased] | ||
|
|
||
| ### Added | ||
| - Added comprehensive docstring to `FeeAssessmentMethod` enum explaining inclusive vs exclusive fee assessment methods. (#1391) | ||
|
||
| - Added comprehensive training documentation for the `Query` class, covering execution flow, payments, retries, and building child queries. (#1238) | ||
| - Beginner issue documentation and updated GFI and GFIC templates and documentation | ||
| - Enable auto assignment to good first issues (#1312), archived good first issue support team notification. Changed templates with new assign instruction. | ||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -2,7 +2,17 @@ | |
|
|
||
| class FeeAssessmentMethod(Enum): | ||
| """ | ||
| Represents the fee assessment method for custom fees. | ||
| Fee assessment method for custom token fees: | ||
|
|
||
| • INCLUSIVE - Fee is deducted from the transferred amount. | ||
|
||
| The recipient receives the transferred amount minus the fee. | ||
|
|
||
| • EXCLUSIVE - Fee is charged in addition to the transferred amount. | ||
| The recipient receives the full transferred amount, and the payer | ||
exploreriii marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| pays the fee on top of that. | ||
|
|
||
| This determines whether custom fees are taken from the transaction amount | ||
|
||
| or charged separately. | ||
| """ | ||
exploreriii marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| INCLUSIVE = 0 | ||
|
|
||
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.
Changelog entry is incomplete—missing the EXCLUSIVE enum member addition.
The changelog entry only mentions the docstring addition, but the code changes also introduce a new
EXCLUSIVE = 1enum member. This is a functional change to the public API that should be documented in the changelog.📝 Suggested changelog update
📝 Committable suggestion