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

Update docs #872

Merged
merged 11 commits into from
Jan 8, 2025
Merged

Update docs #872

merged 11 commits into from
Jan 8, 2025

Conversation

bw4sz
Copy link
Collaborator

@bw4sz bw4sz commented Jan 6, 2025

No description provided.

@bw4sz bw4sz changed the title Update docs [WIP] Update docs Jan 6, 2025
@bw4sz
Copy link
Collaborator Author

bw4sz commented Jan 6, 2025

I did a doc run with the aim of

  1. Covering updates to code that are outdate, like visualize.plot_results() or any return_plot=True
  2. Reducing any text that gives a 'tree' first or only feel to the package.
  3. Added a prediction page to the 'user guide' that covers the pieces that are in 'getting started', closes The predict page is harder to see in the docs. #863, and related to Batch Predicitions #856

src/deepforest/main.py Outdated Show resolved Hide resolved
@bw4sz bw4sz requested a review from henrykironde January 7, 2025 20:51
@bw4sz bw4sz changed the title [WIP] Update docs Update docs Jan 7, 2025
@henrykironde
Copy link
Contributor

Still need some changes in the comparison.rst I am reviewing it

Copy link
Contributor

@henrykironde henrykironde left a comment

Choose a reason for hiding this comment

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

@bw4sz, this section contains duplicate content and feels a bit lengthy. I've tried condensing it into a shorter version—could you take a look and see if we can find a balance between the original and the shorter version? Of course, this is subjective, so feel free to share your thoughts.

docs/getting_started/comparison.rst Outdated Show resolved Hide resolved
@henrykironde henrykironde added the Awaiting author contribution Waiting on the issue author to do something before proceeding label Jan 8, 2025
@github-actions github-actions bot removed the Awaiting author contribution Waiting on the issue author to do something before proceeding label Jan 8, 2025
@henrykironde henrykironde merged commit ef4435c into main Jan 8, 2025
4 checks passed
@henrykironde henrykironde deleted the update_docs branch January 8, 2025 18:54
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.

2 participants