Giter Site home page Giter Site logo

DOC: seaborn.set_context should note that it sets the global defaults for all plots using the matplotlib rcParams system about seaborn HOT 6 CLOSED

rootsmusic avatar rootsmusic commented on June 9, 2024
DOC: seaborn.set_context should note that it sets the global defaults for all plots using the matplotlib rcParams system

from seaborn.

Comments (6)

mwaskom avatar mwaskom commented on June 9, 2024

This is called out in a few places including the Intro page, aesthetics tutorial, and in the docs for the main set_theme function:

This function changes the global defaults for all plots using the matplotlib rcParams system. The themeing is decomposed into several distinct sets of parameter values.

Always hard to know when it becomes counterproductive to redundantly explain basic principles (which I'd consider this) on more focused documentation pages...

from seaborn.

mwaskom avatar mwaskom commented on June 9, 2024

Additionally, the page you link says

This affects things like the size of the labels, lines, and other elements of the plot, but not the overall style. This is accomplished using the matplotlib rcParams system.

So I am not sure how much additional explanation to add here? The matplotlib <> seaborn interaction can be a little bit confusing but I'd think that this is conveying the relevant information.

from seaborn.

rootsmusic avatar rootsmusic commented on June 9, 2024

Additionally, the page you link says

This affects things like the size of the labels, lines, and other elements of the plot, but not the overall style. This is accomplished using the matplotlib rcParams system.

When I read the quoted sentences above, I interpreted "this" to be referring to seaborn.set_context. So my understanding was that they're explaining how this function works. My understanding wasn't that this function sets the global defaults for all plots using the rcParams system.

Indeed, the doc for set_theme does note that "function changes the global defaults for all plots using the matplotlib rcParams system". Since I'm not familiar with rcParams, I'm looking up the doc for set_context to learn if it requires set_theme to also be explicitly called in conjunction.

from seaborn.

mwaskom avatar mwaskom commented on June 9, 2024

I'm looking up the doc for set_context to learn if it requires set_theme to also be explicitly called in conjunction.

It does not. set_theme changes multiple parameter groups in one call. set_context changes only a subset of those parameters. Mostly you'll want to be calling set_theme. Probably I wouldn't have added separate set_context, set_style functions these days, but they've been around basically forever.

from seaborn.

rootsmusic avatar rootsmusic commented on June 9, 2024

This is called out in a few places including the Intro page, aesthetics tutorial, and in the docs for the main set_theme function:

Because I directly referenced the API docs, I didn't come across the tutorials. "Controlling figure aesthetics" is a helpful tutorial. It's linked in the doc for set_style, which similarly explained: "The style parameters control properties like the color of the background and whether a grid is enabled by default. This is accomplished using the matplotlib rcParams system." (You can close this issue. Thanks for clarifying!)

from seaborn.

mwaskom avatar mwaskom commented on June 9, 2024

Good point that this docstring should cross-reference to the tutorial page. Thanks!

from seaborn.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.