docs icon indicating copy to clipboard operation
docs copied to clipboard

New Entry and Terms: Python modules

Open SSwiniarski opened this issue 2 years ago • 5 comments

Description

From the Target Keyword list. Gives a location for all the 3rd party Python modules we don't need to go into detail about.

Type of Change

  • Adding a new entry
  • Editing an existing entry (fixing a typo, bug, issues, etc)

Checklist

  • [x] All writings are my own.
  • [x] My entry follows the Codecademy Docs style guide.
  • [x] My changes generate no new warnings.
  • [x] I have performed a self-review of my own writing and code.
  • [x] I have checked my entry and corrected any misspellings.
  • [x] I have made corresponding changes to the documentation if needed.
  • [x] I have confirmed my changes are not being pushed from my forked main branch.
  • [x] I have confirmed that I'm pushing from a new branch named after the changes I'm making.
  • [x] Under "Development" on the right, I have linked any issues that are relevant to this PR (write "Closes # in the "Description" above).

SSwiniarski avatar Aug 24 '22 17:08 SSwiniarski

@Dusch4593 Do you think that the Numpy and Pandas references would be better linked to in the module article than as terms? The more I think about it, the more I think there's a potential for confusion, especially when linking out to the Docs entry.

EDIT: I'm going ahead and making that edit, It just seems to make more sense.

SSwiniarski avatar Aug 26 '22 15:08 SSwiniarski

@Dusch4593 I completed all your suggestions.

SSwiniarski avatar Aug 26 '22 15:08 SSwiniarski

@Dusch4593 anything more you think needs to be done?

SSwiniarski avatar Aug 31 '22 16:08 SSwiniarski

@yangc95, I implemented your suggestions.

SSwiniarski avatar Sep 07 '22 16:09 SSwiniarski

@yangc95 I implemented your latest updates.

SSwiniarski avatar Sep 14 '22 16:09 SSwiniarski

@Dusch4593, Does this look good to merge, or do you think we need another review?

SSwiniarski avatar Sep 27 '22 13:09 SSwiniarski

I don't think another review will be needed, but I made some edits to modules.md in 13a82f448219eb3965cb4c53817daefc68014b8e and 945526fc2f0ed9a58db5aae6e7b45adab7b23914 that include:

  • Adding a link to General: File Formats near the top of the entry.
  • Some word-smithing in the "Creating and Importing Modules" section.
  • Replaced the collections example (under "Importing Specific Resources") to stick with the fictional video_player module (plus, collections is linked further down in the entry anyways).
  • Removed instances of "you"/"your".

Dusch4593 avatar Sep 29 '22 16:09 Dusch4593

Also, in f41cab95d673d1fe4cc50a3ba897f98f3928e3bc:

  • I added links for the API and data science entries under pyspark.md.
  • I removed the link to open source in pytourch.md (since it would break after #935 is merged) and turned link text for NumPy entry to CamelCase.

Unless there's anything else we're missing, this PR should be good to merge. 😄

Dusch4593 avatar Sep 29 '22 16:09 Dusch4593