chore: improved doc comments

golemfactory · Jun 26, 2024 · 36626b8 · 36626b8
1 parent f1b6370
commit 36626b8
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 5 deletions.
diff --git a/src/market/draft-offer-proposal-pool.ts b/src/market/draft-offer-proposal-pool.ts
@@ -10,14 +10,14 @@ export type OfferProposalSelector = (proposals: OfferProposal[]) => OfferProposa
 
 export interface ProposalPoolOptions {
   /**
-   * A user-defined function that will be used by {@link DraftOfferProposalPool.acquire} to pick the best fitting proposal from available ones
+   * A user-defined function that will be used by {@link DraftOfferProposalPool.acquire} to pick the best fitting offer proposal from available ones
    */
   selectOfferProposal?: OfferProposalSelector;
 
   /**
-   * User defined filter function which will determine if the proposal is valid for use.
+   * User defined filter function which will determine if the offer proposal is valid for use.
    *
-   * Proposals are validated before being handled to the caller of {@link DraftOfferProposalPool.acquire}
+   * Offer proposals are validated before being handled to the caller of {@link DraftOfferProposalPool.acquire}
    */
   validateOfferProposal?: OfferProposalFilter;
 

diff --git a/src/market/market.module.ts b/src/market/market.module.ts
@@ -63,10 +63,10 @@ export interface MarketOptions {
   /** Pricing strategy that will be used to filter the offers from the market */
   pricing: PricingOptions;
 
-  /** A user-defined filter function which will determine if the proposal is valid for use. */
+  /** A user-defined filter function which will determine if the offer proposal is valid for use. */
   offerProposalFilter?: OfferProposalFilter;
 
-  /** A user-defined function that will be used to pick the best fitting proposal from available ones */
+  /** A user-defined function that will be used to pick the best fitting offer proposal from available ones */
   offerProposalSelector?: OfferProposalSelector;
 }