Skip to content

Add abbreviations in the getting_started page #863

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 1 commit into from
Oct 25, 2023

Conversation

LakshmanKishore
Copy link
Contributor

Summary:
This pull request aims to improve the documentation by adding comments to clarify the abbreviations used in getting started page. The goal is to make it more accessible to new users who may not be familiar with these abbreviations.

Changes Made:

  • Added descriptive comments to the sections listing Outlier Detection (od), Adversarial Detection (ad), and Concept Drift Detection (cd) algorithms. These comments help users understand the meaning of the abbreviations and the purpose of each section.

Why is this change needed?
The current documentation uses abbreviations (od, ad, cd) to represent these sections, which might not be immediately clear to new users. By adding these comments, we aim to enhance the user experience and make the documentation more user-friendly.

@LakshmanKishore
Copy link
Contributor Author

Dear maintainers,

I've made these changes to enhance the clarity and accessibility of the documentation, with the aim of helping new users. I kindly request that you consider tagging this contribution with the 'hacktoberfest-accepted' label or adding the 'hacktoberfest' topic to the repository. This would make it easier for participants in Hacktoberfest to find and contribute to this project.

Thank you!

@codecov
Copy link

codecov bot commented Oct 25, 2023

Codecov Report

Merging #863 (0045894) into master (23a4f24) will decrease coverage by 0.03%.
The diff coverage is n/a.

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##           master     #863      +/-   ##
==========================================
- Coverage   82.01%   81.98%   -0.03%     
==========================================
  Files         159      159              
  Lines       10375    10375              
==========================================
- Hits         8509     8506       -3     
- Misses       1866     1869       +3     

see 1 file with indirect coverage changes

@jklaise
Copy link
Contributor

jklaise commented Oct 25, 2023

Thank you for your contribution!

@jklaise jklaise merged commit 5642b02 into SeldonIO:master Oct 25, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants