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

RTD-BF-Streams: Documentation for 3rd Party Support #722

Merged
merged 7 commits into from
Apr 11, 2023
Merged

RTD-BF-Streams: Documentation for 3rd Party Support #722

merged 7 commits into from
Apr 11, 2023

Conversation

laxmikantbaheti
Copy link
Contributor

Description

Background

Checklists:

  • Read the CONTRIBUTION guide (required).
  • Update the history on the source code (required).

@laxmikantbaheti laxmikantbaheti added documentation Improvements or additions to documentation BF Basic Functions/Infrastructure labels Apr 11, 2023
@laxmikantbaheti laxmikantbaheti added this to the Sprint 2023/04 milestone Apr 11, 2023
@laxmikantbaheti laxmikantbaheti self-assigned this Apr 11, 2023
@laxmikantbaheti laxmikantbaheti linked an issue Apr 11, 2023 that may be closed by this pull request
RTD-BF-Streams: Subsection for 3rd-party support #719
Closed
4 tasks
@laxmikantbaheti
Copy link
Contributor Author

Hi @detlefarend , I have added documentation for 3rd party support for stream providers. Please give me a feedback when possible. Thank you!

@detlefarend detlefarend changed the title Doc-RTD-BF-Streams: Documentation for 3rd Party Support RTD-BF-Streams: Documentation for 3rd Party Support Apr 11, 2023
detlefarend
detlefarend reviewed Apr 11, 2023
View reviewed changes
Copy link
Member

@detlefarend detlefarend left a comment

Choose a reason for hiding this comment

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

Hi @laxmikantbaheti, thanks for documenting the wrappers! It is well and clear described. I would change just one thing: I would remove the last subsection "3.5.1.4.4 Accessing the Datasets" and place a Cross Reference part at the end of each wrapper section. Maybe, a small code box for each wrapper import as well...

@laxmikantbaheti
Copy link
Contributor Author

Hi @detlefarend , thanks for the feedback. I have made the suggested changes. Shall I merge this branch to main?

detlefarend
detlefarend approved these changes Apr 11, 2023
View reviewed changes
Copy link
Member

@detlefarend detlefarend left a comment

Choose a reason for hiding this comment

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

Hi @laxmikantbaheti, now it's good. I just corrected some last things: scikit-learn instead Scikitlearn and 1/2 typos. Furthermore, I added a link to the source in the rtd description of howto 051 so that it is also accessible. I'll merge...

@detlefarend detlefarend merged commit db25e54 into main Apr 11, 2023
@detlefarend detlefarend deleted the doc/rtd/bf/streams/3rd_party_support branch April 11, 2023 20:54
@laxmikantbaheti
Copy link
Contributor Author

Hi @laxmikantbaheti, now it's good. I just corrected some last things: scikit-learn instead Scikitlearn and 1/2 typos. Furthermore, I added a link to the source in the rtd description of howto 051 so that it is also accessible. I'll merge...

Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@detlefarend detlefarend detlefarend approved these changes

Assignees

@laxmikantbaheti laxmikantbaheti

Labels
BF Basic Functions/Infrastructure documentation Improvements or additions to documentation v1.2.0 Extension Hub
Projects
None yet
Milestone
Sprint 2023/04
Development

Successfully merging this pull request may close these issues.

RTD-BF-Streams: Subsection for 3rd-party support
2 participants
@laxmikantbaheti @detlefarend