Skip to content

Improve clarify of early binding functions documentation#1677

Merged
JeanChristopheMorinPerso merged 10 commits intoAcademySoftwareFoundation:mainfrom
BryceGattis:feature/early_this_documentation
Mar 29, 2024
Merged

Improve clarify of early binding functions documentation#1677
JeanChristopheMorinPerso merged 10 commits intoAcademySoftwareFoundation:mainfrom
BryceGattis:feature/early_this_documentation

Conversation

@BryceGattis
Copy link
Copy Markdown
Contributor

Added new information about accessible package attributes and environment variables.

Looking for some help clarifying exactly what language we should use here and where everything should live.

Just trying to clarify:

  • What packages attributes can be used inside an early bound function.
  • When environment variables can be read inside of packages and if there are certain situations where they cannot be read (ex. early bound functions).

…nt variables

Signed-off-by: Bryce Gattis <brycegattis@yahoo.com>
@BryceGattis BryceGattis requested a review from a team as a code owner March 6, 2024 05:35
Signed-off-by: Bryce Gattis <brycegattis@yahoo.com>
@BryceGattis
Copy link
Copy Markdown
Contributor Author

BryceGattis commented Mar 6, 2024

It may be nice to add a blurb at the top of this file that mentions that environment variables on this page can or cannot be used inside of the package.py file itself. What do we think?

Signed-off-by: Bryce Gattis <brycegattis@yahoo.com>
Signed-off-by: Bryce Gattis <brycegattis@yahoo.com>
Comment thread docs/source/package_definition.rst Outdated
Comment thread docs/source/package_definition.rst Outdated
Signed-off-by: Bryce Gattis <brycegattis@yahoo.com>
Signed-off-by: Bryce Gattis <brycegattis@yahoo.com>
Signed-off-by: Bryce Gattis <brycegattis@yahoo.com>
Comment thread docs/source/package_definition.rst Outdated
Signed-off-by: Bryce Gattis <brycegattis@yahoo.com>
Signed-off-by: Bryce Gattis <brycegattis@yahoo.com>
Copy link
Copy Markdown
Member

@JeanChristopheMorinPerso JeanChristopheMorinPerso left a comment

Choose a reason for hiding this comment

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

Thanks again for another great contribution @BryceGattis!

Signed-off-by: Bryce Gattis <brycegattis@yahoo.com>
@JeanChristopheMorinPerso JeanChristopheMorinPerso changed the title Early binding functions documentation Improve clarify of early binding functions documentation Mar 29, 2024
@JeanChristopheMorinPerso JeanChristopheMorinPerso merged commit b9eb38a into AcademySoftwareFoundation:main Mar 29, 2024
Pixel-Minions added a commit to Pixel-Minions/rez that referenced this pull request Sep 26, 2024
…wareFoundation#1677)

Improve clarify of early binding functions documentation by documenting what is accessible within an early function.

Signed-off-by: Bryce Gattis <brycegattis@yahoo.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants