Update documentation

Open
#447 1 comment 0 reactions 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
Mostly clear
Activity status
Stale
Tech stack
python
Domain
documentation

Research direction

Start with the basic usage documentation at https://equinor.github.io/tagreader-python/docs/about/usage/basic-usage and compare its examples with the current tagreader-python functions. Update outdated names such as verifySSL to verify_ssl and check the surrounding examples for other mismatches; done means the documentation reflects the current API.

Written by the indexing model from the issue text.

Description

Hi,

We see that there are many changes to the functions in tagreader-python. But the documentation doesn't reflect that. For example, the verifySSL is now verify_ssl.

Can you please have a look at this because it will save us time in the future?

Shrey

Dominant language
Python
Stars
55
Forks
21
Avg merge
2d 5h
Merged PRs (30d)
4

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 equinor/tagreader-python

All issues in equinor/tagreader-python

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.