Document `iris.site_configuration`?

Open
#5,974 2 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
35/100
Issue type
Documentation
Clarity
Needs clarification
Activity status
Stale
Tech stack
python
Domain
documentation

Research direction

Start by reading the Iris documentation at scitools-iris.readthedocs.io and the details in issue #5255's linked comment about iris.site_configuration. Determine whether the feature should be documented or removed, then make the chosen outcome clear in the documentation or issue resolution.

Written by the indexing model from the issue text.

Description

Type: Documentation

📚 Documentation

This is a pretty valuable feature. I have heard suggestions that it might be undocumented because it's a backdoor that we don't want to advertise, but I personally think it's a good thing - either document or remove IMO.

See here for some details of what it does: https://github.com/SciTools/iris/issues/5255#issuecomment-2125300801

Dominant language
Python
Stars
724
Forks
317
Avg merge
3d 20h
Merged PRs (30d)
9

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from SciTools/iris

All issues in SciTools/iris

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.