Skip to content

Commit 3218660

Browse files
committed
docs: updated 179 broken links
1 parent 7012df9 commit 3218660

File tree

9 files changed

+138
-131
lines changed

9 files changed

+138
-131
lines changed

CONTRIBUTING.md

+29-27
Original file line numberDiff line numberDiff line change
@@ -1,45 +1,45 @@
11
## How to contribute to Pandas-Profiling
22

3-
Pandas-profiling aims to ease exploratory data analysis for structured datasets, including time-series.
3+
Pandas-profiling aims to ease exploratory data analysis for structured datasets, including time-series.
44
Our focus is to provide users with useful and robust statistics for such datasets encountered in industry, academia and elsewhere.
55
Pandas-profiling is open-source and stimulates contributions from passionate community users.
66

7-
#### Themes to contribute
87

8+
#### Themes to contribute
99
In line with our aim, we identify the following themes:
1010

11-
- **Exploratory data analysis**:
11+
- **Exploratory data analysis**:
1212
The core of the package is a dataset summarization by its main characteristics, which is complemented with warnings on data issues and visualisations.
1313

14-
_Suggestions for contribution_:
14+
_Suggestions for contribution_:
1515
Extend the support of more data types (think of paths, location or GPS coordinates and ordinal data types),
16-
text data (e.g. encoding, vocabulary size, spelling errors, language detection),
17-
time series analysis,
16+
text data (e.g. encoding, vocabulary size, spelling errors, language detection),
17+
time series analysis,
1818
or even images (e.g. dimensions, EXIF).
19-
19+
2020
_Related_: [#7][i7], [#129][i129], [#190][i190], [#204][i204] or [create one](https://github.com/ydataai/ydata-profiling/issues/new/choose).
2121

22-
- **Stability, Performance and Restricted environment compatibility:**
22+
- **Stability, Performance and Restricted environment compatibility:**
2323
Data exploration takes place in all kinds of conditions, on the latest machine learning platforms with enormous dataset to managed environments in large corporations.
2424
`pandas-profiling` helps analysts, researchers and engineers alike in these cases.
2525
We do this by fixing bugs, improving performance on big datasets and adding environment compatibility.
26-
27-
_Suggestions for contribution (Performance)_:
28-
Perform concurrency analysis or profile execution times and leverage the gained insights for improved performance (e.g. multiprocessing, cython, numba) or test the performance of `pandas-profiling` with [big data sets](https://www.stats.govt.nz/large-datasets/csv-files-for-download/) and corresponding commonly used data formats (such as parquet).
29-
30-
_Suggestions for contribution (Stability)_:
26+
27+
_Suggestions for contribution (Performance)_:
28+
Perform concurrency analysis or profile execution times and leverage the gained insights for improved performance (e.g. multiprocessing, cython, numba) or test the performance of `pandas-profiling` with [big data sets](https://www.stats.govt.nz/large-datasets/csv-files-for-download/) and corresponding commonly used data formats (such as parquet).
29+
30+
_Suggestions for contribution (Stability)_:
3131
Either review the code and add tests or watch the [issues page](https://github.com/ydataai/ydata-profiling/issues) and [Stackoverflow tag](https://stackoverflow.com/questions/tagged/pandas-profiling) to find current issues.
32-
32+
3333
_Related_: [#98][i98], [#122][i122] or [create one](https://github.com/ydataai/ydata-profiling/issues/new/choose).
3434

35-
- **Interaction, presentation and user experience**:
35+
- **Interaction, presentation and user experience**:
3636
As `pandas-profiling` eases exploratory data analysis, working with the package should reflect that.
3737
Interaction and user experience plays a central role in working with the package.
3838
Working on interactive and static features is possible through the modular nature of the package: the user can configure which features to use.
3939

4040
_Suggestions for contribution (interactivity)_:
41-
Interactivity allows for more user friendly applications, including but not limited to on demand analysis (don't compute what you don't want to see) and interactive histograms and correlations.
42-
This is ideal for smaller datasets, where we can compute this on-the-fly.
41+
Interactivity allows for more user friendly applications, including but not limited to on demand analysis (don't compute what you don't want to see) and interactive histograms and correlations.
42+
This is ideal for smaller datasets, where we can compute this on-the-fly.
4343
`ipywidgets` would be a great place to start (e.g. [widget based view](https://ipywidgets.readthedocs.io/en/stable/examples/Widget%20List.html)).
4444

4545
_Suggestions for contribution (presentation)_:
@@ -48,17 +48,17 @@ In line with our aim, we identify the following themes:
4848

4949
_Related_: [#161][i161], [#175][i175], [#191][i191] or [create one](https://github.com/ydataai/ydata-profiling/issues/new/choose).
5050

51-
- **Community**:
51+
- **Community**:
5252
The success of this package demonstrates the power of sharing and working together.
5353
You are welcome as part of this community.
54-
54+
5555
_Suggestions for contribution_:
5656
Share with us if this package is of value to you, let us know [in our community](https://discord.com/invite/mw7xjJ7b7s).
5757
We are interested in how you use `pandas-profiling` in your work.
58-
58+
5959
_Related_: [#87][i87] or [create one](https://github.com/ydataai/ydata-profiling/issues/new/choose).
6060

61-
- **Machine learning:**
61+
- **Machine learning:**
6262
`pandas-profiling` is not a machine learning package, even though many of our users use EDA as a step prior to developing their models.
6363
Our focus lies in the exploratory data analysis.
6464
Any functionality that enables machine learning applications by more effective data profiling, is welcome.
@@ -67,17 +67,18 @@ In line with our aim, we identify the following themes:
6767

6868
#### **Did you find a bug?**
6969

70-
- **Ensure the bug was not already reported** by searching on Github under [Issues](https://github.com/ydataai/ydata-profiling/issues).
70+
* **Ensure the bug was not already reported** by searching on Github under [Issues](https://github.com/ydataai/ydata-profiling/issues).
7171

72-
- If you're unable to find an open issue addressing the problem, [open a new one](https://github.com/ydataai/ydata-profiling/issues/new/choose).
73-
If possible, use the relevant bug report templates to create the issue.
72+
* If you're unable to find an open issue addressing the problem, [open a new one](https://github.com/ydataai/ydata-profiling/issues/new/choose).
73+
If possible, use the relevant bug report templates to create the issue.
7474

7575
#### **Did you write a patch that fixes a bug?**
7676

77-
- Open a new Github pull request with the patch.
77+
* Open a new Github pull request with the patch.
78+
79+
* Ensure the PR description clearly describes the problem and solution.
80+
Include the relevant issue number if applicable.
7881

79-
- Ensure the PR description clearly describes the problem and solution.
80-
Include the relevant issue number if applicable.
8182

8283
#### Acknowledgements
8384

@@ -98,3 +99,4 @@ See the [Contributor Graph](https://github.com/ydataai/ydata-profiling/graphs/co
9899
[i161]: https://github.com/ydataai/ydata-profiling/issues/161
99100
[i175]: https://github.com/ydataai/ydata-profiling/issues/175
100101
[i191]: https://github.com/ydataai/ydata-profiling/issues/191
102+

0 commit comments

Comments
 (0)