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: improve docgen #2043

Merged
merged 4 commits into from
Aug 7, 2023
Merged

fix: improve docgen #2043

merged 4 commits into from
Aug 7, 2023

Conversation

eisber
Copy link
Contributor

@eisber eisber commented Aug 7, 2023

add missing package dependency
fix channel resolution

Related Issues/PRs

#xxx

What changes are proposed in this pull request?

Briefly describe the changes included in this Pull Request.

How is this patch tested?

  • I have written tests (not required for typo or doc fix) and confirmed the proposed feature/bug-fix/change works.

Does this PR change any dependencies?

  • No. You can skip this section.
  • Yes. Make sure the dependencies are resolved correctly, and list changes here.

Does this PR add a new feature? If so, have you added samples on website?

  • No. You can skip this section.
  • Yes. Make sure you have added samples following below steps.
  1. Find the corresponding markdown file for your new feature in website/docs/documentation folder.
    Make sure you choose the correct class estimators/transformers and namespace.
  2. Follow the pattern in markdown file and add another section for your new API, including pyspark, scala (and .NET potentially) samples.
  3. Make sure the DocTable points to correct API link.
  4. Navigate to website folder, and run yarn run start to make sure the website renders correctly.
  5. Don't forget to add <!--pytest-codeblocks:cont--> before each python code blocks to enable auto-tests for python samples.
  6. Make sure the WebsiteSamplesTests job pass in the pipeline.

add missing package dependency
fix channel resolution
@github-actions
Copy link

github-actions bot commented Aug 7, 2023

Hey @eisber 👋!
Thank you so much for contributing to our repository 🙌.
Someone from SynapseML Team will be reviewing this pull request soon.

We use semantic commit messages to streamline the release process.
Before your pull request can be merged, you should make sure your first commit and PR title start with a semantic prefix.
This helps us to create release messages and credit you for your hard work!

Examples of commit messages with semantic prefixes:

  • fix: Fix LightGBM crashes with empty partitions
  • feat: Make HTTP on Spark back-offs configurable
  • docs: Update Spark Serving usage
  • build: Add codecov support
  • perf: improve LightGBM memory usage
  • refactor: make python code generation rely on classes
  • style: Remove nulls from CNTKModel
  • test: Add test coverage for CNTKModel

To test your commit locally, please follow our guild on building from source.
Check out the developer guide for additional guidance on testing your change.

Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

Summary by GPT-4

The changes made in this commit are as follows:

  1. In the README.md file, instructions on how to run the tool have been added. This includes changing the directory to tools/docgen, installing the required packages using pip install -e ., and running the tool using python -m docgen --manifest docgen-manifest.yaml.

  2. In the docgen/__main__.py file, a minor change has been made to add an extra line after importing a module.

  3. In the docgen/channels.py file, a change has been made to fix an issue with parsing HTML content. The BeautifulSoup constructor now includes the features="html.parser" argument.

  4. In the setup.py file, a new dependency, "markdown", has been added to the list of required packages.

These changes improve the usability of the tool by providing clear instructions on how to run it and fixing issues related to parsing HTML content.

Suggestions

No suggestions are needed as the changes in this PR seem appropriate and well-implemented.

@eisber eisber changed the title improve docgen fix: improve docgen Aug 7, 2023
@mhamilton723
Copy link
Collaborator

/azp run

@azure-pipelines
Copy link

Azure Pipelines successfully started running 1 pipeline(s).

@codecov-commenter
Copy link

codecov-commenter commented Aug 7, 2023

Codecov Report

Merging #2043 (8034413) into master (9eff35f) will decrease coverage by 3.63%.
Report is 1 commits behind head on master.
The diff coverage is n/a.

@@            Coverage Diff             @@
##           master    #2043      +/-   ##
==========================================
- Coverage   87.05%   83.43%   -3.63%     
==========================================
  Files         306      306              
  Lines       16063    16063              
  Branches      852      852              
==========================================
- Hits        13984    13402     -582     
- Misses       2079     2661     +582     

see 33 files with indirect coverage changes

@mhamilton723 mhamilton723 merged commit f6328b5 into microsoft:master Aug 7, 2023
7 checks passed
JessicaXYWang pushed a commit to JessicaXYWang/SynapseML that referenced this pull request Sep 14, 2023
* improve readme
add missing package dependency
fix channel resolution

* revert docgen module prefix

* remove module_name prefix

---------
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants