Codecademy / docs

Codecademy Docs is a collection of information for all things code. 📕
https://www.codecademy.com/resources/docs
702 stars 3.25k forks source link

[Edit] os.path.join #4351

Open jeremyngcode opened 5 months ago

jeremyngcode commented 5 months ago

Type of Edit (select all that apply)

Clarify unclear content and/or terms

Description (optional)

In the .join() method from this page, it seems that the explanation is missing some nuance as to how this method behaves, one example being that if any argument begins with a /, then all previous arguments will be skipped.

However, I do understand also if Codecademy has intentionally kept it simple. If this is the case, then I believe the / in "learn-python-3/lessons/" should be removed in order to align with the explanation given above it which says "Before being added to the returned value, each subsequent path_ string is prepended with a forward-slash /", because if not, then there would be a double forward-slash in the path string.

If a more elaborate explanation for the .join() method isn't desired, then this should be a quick fix. I can expand on this also if that is ok with the team.

Code of Conduct

For Maintainers

RobinNap commented 4 months ago

@jeremyngcode Would I be able to take this issue?

jeremyngcode commented 4 months ago

Hi @RobinNap, this issue isn't opened by the team, it's opened by me.

scottfinamore commented 4 months ago

I am still waiting to complete my first issue on Codecademy's GitHub. May I please work on this issue for the completion of my program? Thank you!

nbarnhouse commented 3 weeks ago

Hi @codecademy-docs I would like to work on this.