Skip to content

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

Merged
Yuqing-cat merged 2 commits intofeathr-ai:mainfrom
Yuqing-cat:docfix
Jun 21, 2022
Merged

Fix Python doc links in Docs and add HdfsSink back#383
Yuqing-cat merged 2 commits intofeathr-ai:mainfrom
Yuqing-cat:docfix

Conversation

@Yuqing-cat
Copy link
Collaborator

@Yuqing-cat Yuqing-cat commented Jun 20, 2022 •
edited by jainr
Loading

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
@Yuqing-cat Yuqing-cat linked an issue Jun 20, 2022 that may be closed by this pull request
Python Doc links in Docs are not updated after a folder structure upgrade #382
Closed
@xiaoyongzhu
Copy link
Member

xiaoyongzhu commented Jun 21, 2022

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

Yuqing-cat commented Jun 21, 2022

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
blrchen
blrchen reviewed Jun 21, 2022
View reviewed changes
feathr_project/feathr/__init__.py
'MaterializationSettings',
'MonitoringSettings',
'RedisSink',
'HdfsSink',
Copy link
Collaborator

@blrchen blrchen Jun 21, 2022 •
edited
Loading

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

Reviewers

@blrchen blrchen blrchen left review comments

@xiaoyongzhu xiaoyongzhu xiaoyongzhu approved these changes

@jainr jainr jainr approved these changes

@hangfei hangfei Awaiting requested review from hangfei

@jaymo001 jaymo001 Awaiting requested review from jaymo001

@edwincheung edwincheung Awaiting requested review from edwincheung

@windoze windoze Awaiting requested review from windoze

Assignees

No one assigned

Labels

bug Something isn't working documentation Improvements or additions to documentation

Projects

None yet

Milestone

No milestone

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

@Yuqing-cat @xiaoyongzhu @blrchen @jainr