Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Add some documentation for Env related interfaces #12813

Closed
wants to merge 2 commits into from
Closed

Add some documentation for Env related interfaces #12813

wants to merge 2 commits into from

Conversation

jowlyzhang
Copy link
Contributor

As titled. Added some documentations for some Env interfaces and removed some obsolete doc for Options.env.

ajkr
ajkr reviewed Jun 27, 2024
View reviewed changes
Copy link
Contributor

@ajkr ajkr left a comment

Choose a reason for hiding this comment

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

I think LegacyFileSystemWrapper is closely related enough that we should document it here too. I often get stuck on the relationship between CompositeEnv and LegacyFileSystemWrapper.

@jowlyzhang
Copy link
Contributor Author

I think LegacyFileSystemWrapper is closely related enough that we should document it here too. I often get stuck on the relationship between CompositeEnv and LegacyFileSystemWrapper.

That's a good call! Thank you for the suggestion. I added some documentation for it.

@facebook-github-bot
Copy link
Contributor

@jowlyzhang has imported this pull request. If you are a Meta employee, you can view this diff on Phabricator.

ajkr
ajkr approved these changes Jun 29, 2024
View reviewed changes
Copy link
Contributor

@ajkr ajkr left a comment

Choose a reason for hiding this comment

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

LegacyFileSystemWrapper has FileSystem functions call back into its parent Env.
CompositeEnv has Env functions call into its child FileSystem
Composing them does not sound like a good idea

I probably never understood it until now - thanks!

@facebook-github-bot
Copy link
Contributor

@jowlyzhang merged this pull request in 8c1558a.

@jowlyzhang jowlyzhang deleted the env_doc branch July 11, 2024 19:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ajkr ajkr ajkr approved these changes

Assignees
No one assigned
Labels
CLA Signed Merged
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@jowlyzhang @facebook-github-bot @ajkr