Skip to content

Update documentation to resolve a small typo in glossary#857

Merged
elijahbenizzy merged 2 commits intoapache:mainfrom
bustosalex1:documentation-typo-fix
Apr 26, 2024
Merged

Update documentation to resolve a small typo in glossary#857
elijahbenizzy merged 2 commits intoapache:mainfrom
bustosalex1:documentation-typo-fix

Conversation

@bustosalex1
Copy link
Contributor

@bustosalex1 bustosalex1 commented Apr 26, 2024

The current glossary page of the Hamilton documentation provides the following definition for "Module | Python Module":

Python code organized into a .py file. exte function written by a user to create a single node (in the standard case) or many (using function modifiers). See Functions, nodes & dataflow.

It appears that everything after the first sentence here may have been accidentally copied from the definition for "Function | Python function | Hamilton function | Node definition". To me this seemed like a likely typo, but if this is intentional feel free to disregard this PR.

Changes

  • Changes definition of "Module | Python Module" in documentation from:

Python code organized into a .py file. exte function written by a user to create a single node (in the standard case) or many (using function modifiers). See Functions, nodes & dataflow.

to

Python code organized into a .py file.

How I tested this

  • I did not test this, since it looks like docs are built in CI.

Notes

Checklist

  • PR has an informative and human-readable title (this will be pulled into the release notes)
  • Changes are limited to a single goal (no scope creep)
  • Code passed the pre-commit check & code is left cleaner/nicer than when first encountered.
  • Any change in functionality is tested
  • New functions are documented (with a description, list of inputs, and expected output)
  • Placeholder code is flagged / future TODOs are captured in comments
  • Project documentation has been updated if adding/changing functionality.

@elijahbenizzy elijahbenizzy self-requested a review April 26, 2024 14:43
@elijahbenizzy
Copy link
Contributor

Thank you @bustosalex1! I addeda. quick line on how they're used + a link. Appreciate the contribution!

@elijahbenizzy elijahbenizzy merged commit a2eb1c7 into apache:main Apr 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants