Skip to content

docs: Migrate docs #99

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 22 commits into from
May 26, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
22 commits
Select commit Hold shift + click to select a range
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
59 changes: 29 additions & 30 deletions .github/CODESTYLE.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ follow throughout the development of your contribution.
as specified in [PEP 287](https://peps.python.org/pep-0287/)
- Private attributes are to be prefixed with an underscore
- Use of [typing](https://docs.python.org/3/library/typing.html) type hints
- All files are to use 2 space indenting
- All files are to use 4 space indenting

```python
class ExampleClass:
Expand All @@ -31,28 +31,28 @@ class ExampleClass:
public_attribute : int # type hint for integer is defined here

def __init__(
self,
public_attribute: int # type hint for parameters
self,
public_attribute: int # type hint for parameters
) -> None: # the expected return value of method
"""
Initializes a ExampleClass
"""
Initializes a ExampleClass

Parameters
----------
:param public_attribute: example attribute
"""
self.public_attribute = public_attribute
self.private_attribute = square(public_attribute)
Parameters
----------
:param public_attribute: example attribute
"""
self.public_attribute = public_attribute
self.private_attribute = square(public_attribute)

def square(self, value: int) -> int:
"""
Example method that square roots a value

Parameters
----------
:param value: value that you want squared
"""
return value**2
"""
Example method that square roots a value

Parameters
----------
:param value: value that you want squared
"""
return value**2
```

## Markdown Guidelines
Expand All @@ -68,28 +68,27 @@ Currently, documentation for this project resides in markdown files.

```markdown
<!--example markdown document-->

# Section

Lorem ipsum dolor sit amet, consectetur adipiscing elit,
sed do eiusmod tempor incididunt ut labore et dolore
magna aliqua. Ut enim ad minim veniam, quis nostrud
exercitation ullamco laboris nisi ut aliquip ex ea
commodo consequat. Duis aute irure dolor in
reprehenderit in voluptate velit esse cillum dolore eu
fugiat nulla pariatur. Excepteur sint occaecat cupidatat
non proident, sunt in culpa qui officia deserunt mollit
sed do eiusmod tempor incididunt ut labore et dolore
magna aliqua. Ut enim ad minim veniam, quis nostrud
exercitation ullamco laboris nisi ut aliquip ex ea
commodo consequat. Duis aute irure dolor in
reprehenderit in voluptate velit esse cillum dolore eu
fugiat nulla pariatur. Excepteur sint occaecat cupidatat
non proident, sunt in culpa qui officia deserunt mollit
anim id est laborum. found [Lorem Ipsum Generator]



# Section 2

<ul>
<li> Apple
<li> Orange
<li> Pineapple
</ul>



[Lorem Ipsum Generator]: https://loremipsum.io/generator/
```

Expand Down
24 changes: 12 additions & 12 deletions .github/CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,23 +17,23 @@ diverse, inclusive, and healthy community.
Examples of behavior that contributes to a positive environment for our
community include:

* Demonstrating empathy and kindness toward other people
* Being respectful of differing opinions, viewpoints, and experiences
* Giving and gracefully accepting constructive feedback
* Accepting responsibility and apologizing to those affected by our mistakes,
- Demonstrating empathy and kindness toward other people
- Being respectful of differing opinions, viewpoints, and experiences
- Giving and gracefully accepting constructive feedback
- Accepting responsibility and apologizing to those affected by our mistakes,
and learning from the experience
* Focusing on what is best not just for us as individuals, but for the
- Focusing on what is best not just for us as individuals, but for the
overall community

Examples of unacceptable behavior include:

* The use of sexualized language or imagery, and sexual attention or
- The use of sexualized language or imagery, and sexual attention or
advances of any kind
* Trolling, insulting or derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or email
- Trolling, insulting or derogatory comments, and personal or political attacks
- Public or private harassment
- Publishing others' private information, such as a physical or email
address, without their explicit permission
* Other conduct which could reasonably be considered inappropriate in a
- Other conduct which could reasonably be considered inappropriate in a
professional setting

## Enforcement Responsibilities
Expand Down Expand Up @@ -105,7 +105,7 @@ Violating these terms may lead to a permanent ban.
### 4. Permanent Ban

**Community Impact**: Demonstrating a pattern of violation of community
standards, including sustained inappropriate behavior, harassment of an
standards, including sustained inappropriate behavior, harassment of an
individual, or aggression toward or disparagement of classes of individuals.

**Consequence**: A permanent ban from any sort of public interaction within
Expand All @@ -124,4 +124,4 @@ enforcement ladder](https://github.com/mozilla/diversity).

For answers to common questions about this code of conduct, see the FAQ at
https://www.contributor-covenant.org/faq. Translations are available at
https://www.contributor-covenant.org/translations.
https://www.contributor-covenant.org/translations.
33 changes: 14 additions & 19 deletions .github/ISSUE_TEMPLATE/1-bug-report.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,63 +4,58 @@ about: "Report an issue to help the project improve."
title: "[Bug] "
labels: "Type: Bug"
assignees: caffeine-addictt

---

# Bug report

Your issue may already be reported!
Please check out our [active issues](https://github.com/python-thread/thread/issues) before creating one.



## Expected Behavior

<!--
If you're describing a bug, tell us what should happen
If you're suggesting a change/improvement, tell us how it should work

Please include screenshots and/or code snippets if applicable
-->



## Current Behavior

<!--
If describing a bug, tell us what happens instead of the expected behavior
If suggesting a change/improvement, explain the difference from current behavior

Please include screenshots and/or code snippets if applicable
-->



## Is this a regression?

<!--
Did this behaviour use to work in previous versions?
If yes, what is the latest version where this behaviour is not present?
-->



## Possible Solution

<!--
Not obligatory, but suggest a fix/reason for the bug
or ideas how to implement the addition or change
-->



## Steps to Reproduce (for bugs)

<!--
Provide a link to a live example, or an unambiguous set of steps to reproduce this bug.
-->

1.
2.
3.
4.



## Context

<!--
How has this issue affected you?
What are you trying to accomplish?
Expand All @@ -70,13 +65,13 @@ Providing context helps us come up with a solution that is most useful in the re
Please include screenshots and/or code snippets if applicable
-->



## Your Environment

<!--
Include as many relevant details about the environment you experienced the bug in
-->
* Version used:
* Python version:
* Link to your project:
* Operating System and version (desktop or mobile):

- Version used:
- Python version:
- Link to your project:
- Operating System and version (desktop or mobile):
14 changes: 5 additions & 9 deletions .github/ISSUE_TEMPLATE/2-failing-test.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,37 +4,33 @@ about: "Report failing tests or CI jobs."
title: "[Test] "
labels: "Type: Test"
assignees: caffeine-addictt

---

# Failing Test

Your issue may already be reported!
Please check out our [active issues](https://github.com/python-thread/thread/issues) before creating one.



## Which Jobs/Tests are Failing?
*


-

## Reason for Failure

<!--
Why is/are this/these job/test(s) failing?
What are we missing to make it pass?
-->



## Media Prove

<!--
If applicable, add screenshots or code snippets to explain the issue
If not applicable, remove this field
-->



## Additional Context

<!--
Any other extra context or information
-->
11 changes: 4 additions & 7 deletions .github/ISSUE_TEMPLATE/3-docs-bug.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,23 +4,21 @@ about: "Report an issue in the project's documentation or README.md file."
title: "[Docs] "
labels: "Documentation"
assignees: caffeine-addictt

---

# Documentation Issue Report

Your issue may already be reported!
Please check out our [active issues](https://github.com/python-thread/thread/issues) before creating one.



## Describe the Bug

<!--
A clear and concise description of the bug
-->



## Steps to Reproduce

<!--
e.g.:
1. Navigate to docs/x
Expand All @@ -33,9 +31,8 @@ e.g.:
3.
4.



## Additional Context

<!--
Any other extra context or information
-->
14 changes: 5 additions & 9 deletions .github/ISSUE_TEMPLATE/4-feature-request.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,40 +4,36 @@ about: "Suggest an idea or possible new feature for this project."
title: "[Feature] "
labels: "Type: Feature"
assignees: caffeine-addictt

---

# Feature Request

Your issue may already be reported!
Please check out our [active issues](https://github.com/python-thread/thread/issues) before creating one.



## Is Your Feature Request Related to an Issue?

<!--
If yes, provide a clear and concise description of what the problem is
E.g.:
Issue #
I'm always frustrated when...
-->



## Describe the Solution You'd Like

<!--
A clear and concise description of what you'd like
-->



## Describe Alternatives You've Considered

<!--
A clear and concise description of other alternatives you have considered
-->



## Additional Context

<!--
Any other extra context or information
-->
Loading