feature-engine / feature_engine

Feature engineering package with sklearn like functionality
https://feature-engine.trainindata.com/
BSD 3-Clause "New" or "Revised" License
1.8k stars 304 forks source link

Feature Creation copy for API doc index.rst #725

Closed Morgan-Sell closed 3 months ago

Morgan-Sell commented 4 months ago

Wrote copy for creation module API Docs index.rst. Copy achieved A++ content grade.

Morgan-Sell commented 4 months ago

hola @solegalli, me alegro que te gustelo! I had to get creative, e.g., "real-world experimentation" ;)

Would you like for all mentions of "Feature-engine" to be capitalized? I ask because you skipped over a few. Lmk and I'll revise the copy.

Voy a comenzar escribir el texto de time series. Vamooossss ;)

solegalli commented 4 months ago

Would you like for all mentions of "Feature-engine" to be capitalized?

Yes please! Thank you!

Morgan-Sell commented 4 months ago

done!

solegalli commented 4 months ago

Could you please rebase main onto the feature branch to fix the tests?

codecov[bot] commented 4 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 98.31%. Comparing base (3571426) to head (cf1ae78). Report is 1 commits behind head on main.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #725 +/- ## ========================================== + Coverage 98.16% 98.31% +0.15% ========================================== Files 103 103 Lines 3930 3928 -2 Branches 771 764 -7 ========================================== + Hits 3858 3862 +4 + Misses 26 23 -3 + Partials 46 43 -3 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

Morgan-Sell commented 4 months ago

hola @solegalli, I added a toctree Sphinx at the bottom of the .rst file. Is that correct? Once we're good on the toctree, we're good to go!

solegalli commented 4 months ago

Hey @Morgan-Sell

Something went wrong with rebase. I should see here only the files that you changed for this PR. But I see 29 files instead.

Could you please check?

Morgan-Sell commented 4 months ago

@solegalli, I see what you're saying. Fortunately, I didn't perform major changes after rebasing. Is the best approach the following?

  1. Checkout commit # 7b422bb78da3279e7c9ee3f6c613d57ea6de7685 which is the commit prior
  2. Rebase correctly
  3. Perform the last changes
  4. Add/commit/push to this PR
solegalli commented 4 months ago

it sounds ok to me

Morgan-Sell commented 3 months ago

Hi @solegalli, I tried the above approach and I ended up with the same result.

I followed the directions on feature-engine contribute docs, so I'm unsure what happened. However, will this be an issue when merging to feature-engine main? It seems somehow I merged main onto seo_copy_creation and didn't squah the commits.

I know it isn't ideal, but I believe/hope it will be fine in the end.