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.

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

Fix Python doc links in Docs and add HdfsSink back #383

Merged
merged 2 commits into from
Jun 21, 2022

Conversation

Yuqing-cat
Copy link
Collaborator

@Yuqing-cat Yuqing-cat commented Jun 20, 2022

Fix the side effect of #198

  • Update all Python doc links in docs
  • Add HdfsSink into __all__ section of feathr_project/feathr/__init__.py
  • Add notes in docs/dev_guide/update_python_docs.md

Note:

  • As mentioned in docs/dev_guide/update_python_docs.md:
    • Add an __all__ section in __init__.py (see code here). Every components that are included in the __all__ section is exposed to end users. Others are not exposed in the pydocs.

I'm not sure if the HdfsSink is not included by design. If it shouldn't expose to users, then the section in docs/concepts/feature-generation.md should be removed.

@Yuqing-cat Yuqing-cat added bug Something isn't working documentation Improvements or additions to documentation labels Jun 20, 2022
@xiaoyongzhu
Copy link
Member

Thanks! In order to make it a bit more user friendly (i.e. users can import from the feathr module, it's a bit manual to add user facing APIs there.

There were some automated ways, but seems they are too automated and need many manual changes to tell whether a certain API is needed or not.

@Yuqing-cat
Copy link
Collaborator Author

Thanks! In order to make it a bit more user friendly (i.e. users can import from the feathr module, it's a bit manual to add user facing APIs there.

There were some automated ways, but seems they are too automated and need many manual changes to tell whether a certain API is needed or not.

I see.
For this PR, I only covered all Python API links in Docs. Currently, we don't have an official guide for which modules should be exposed to users or not. Thus, I cannot help to check if there are other missing modules in all.

@Yuqing-cat Yuqing-cat merged commit b3b126c into feathr-ai:main Jun 21, 2022
@@ -45,6 +45,7 @@
'MaterializationSettings',
'MonitoringSettings',
'RedisSink',
'HdfsSink',
Copy link
Collaborator

@blrchen blrchen Jun 21, 2022

Choose a reason for hiding this comment

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

i am curious why materialize test can pass without this., does that means HdfsSink already included in other place?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Python Doc links in Docs are not updated after a folder structure upgrade
4 participants