Skip to content

Commit

Permalink
Add details about referencing data types and structures
Browse files Browse the repository at this point in the history
  • Loading branch information
davewhipp authored Aug 20, 2024
1 parent da74cc0 commit e8436fe
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions CONTRIBUTION_GUIDELINES.md
Original file line number Diff line number Diff line change
Expand Up @@ -115,6 +115,12 @@ Normal text is written without any special formatting.
- commands
- keywords

**NOTE**: Inline code formatting for data types and data structures should be used *only* when referencing a specific instance of the data type or structure. Otherwise, normal text formatting should be used (e.g., dataframe).

> Here, we introduce {term}`pandas`, which is a common data analysis library in Python that utilizes two key data structures: {term}`DataFrame` and {term}`Series`. The dataframe structure in `pandas` is similar to the dataframe data structure in `R`. Let's begin by creating a new `DataFrame` called `my_data`.
In the text above we can see that the pandas library is mentioned for the first time, and as an important library we have included a link to the glossary using the {term}`` formatting. This is similar for the first references to DataFrame and Series. After this, we refer to dataframes in general, not a specific instance, so the text is not formatted. Finally, we create a new dataframe instance, so inline code formatting is used.

#### Code blocks

What: Multiline code as part of the Markdown text.
Expand Down

0 comments on commit e8436fe

Please sign in to comment.