Problem/Motivation

Currently the module documentation is no longer easy to understand, new people who want to work on issues of this module are having some trouble understanding how this module works, this is happening because the documentation should be more detailed.

Steps to reproduce

Proposed resolution

Update the README file explaining how to configure this module and how it works.

If you have some doubt you can send me a message.

Remaining tasks

User interface changes

API changes

Data model changes

CommentFileSizeAuthor
#25 3312696-25.patch1.12 KBAnonymous (not verified)
#23 interdiff-3312696-17_23.txt535 bytesanchal_gupta
#23 3312696-23.patch3.18 KBanchal_gupta
#19 3312696-19.patch3.18 KBLeoAlcci
#17 3312696-17.patch3.18 KBelber
#16 3312696-16.patch2.78 KBanoopsingh92
#8 3312696-08.patch2.9 KBLeoAlcci
#5 3312696_5.patch1.84 KBlbonfioli

Issue fork baguettebox-3312696

Command icon Show commands

Start within a Git clone of the project using the version control instructions.

Or, if you do not have SSH keys set up on git.drupalcode.org:

About issue forks

Comments

elber created an issue. See original summary.

anoopsingh92 made their first commit to this issue’s fork.

lbonfioli’s picture

lbonfioli commented
Assigned: Unassigned » lbonfioli

i'll work on this matter.

avpaderno’s picture

avpaderno
he/him
Primary language Italian
Location Brescia, 🇮🇹 🇪🇺
commented
Title: Make module documentation more easier to understand. » Make the module documentation easier to understand
Issue tags: -#novice +Novice
lbonfioli’s picture

lbonfioli commented
StatusFileSize
new 3312696_5.patch1.84 KB

Here are some updates in the README file.

lbonfioli’s picture

lbonfioli commented
Status: Active » Needs review
LeoAlcci’s picture

LeoAlcci commented

I will review it!

LeoAlcci’s picture

LeoAlcci commented
StatusFileSize
new 3312696-08.patch2.9 KB

Amazing job @lbonfioli, I made some changes to readme mostly adding more details and fixing some grammar. Please kindly review it!

elber’s picture

elber
Primary language Portuguese, Brazil
Location Brazil
commented
Assigned: lbonfioli » Unassigned

Hi @lbonfioli, I think you forgot to unassign.

erikaagp’s picture

erikaagp commented
Assigned: Unassigned » erikaagp

I'll review it.

erikaagp’s picture

erikaagp commented
Assigned: erikaagp » Unassigned

Excellent job guys!! it's easy to understand, I just fixed some English grammar errors on the last changes made by Leo with a commit on the branch

erikaagp opened merge request !4

erikaagp’s picture

erikaagp commented

This module doesn't depends => This module doesn't depend
make it work => make it works
to downloadlibrary => to download the library
:)

LeoAlcci’s picture

LeoAlcci commented
Status: Needs review » Needs work

Thanks for spotting those mistakes! =), I just left a recommendation.

elber’s picture

elber
Primary language Portuguese, Brazil
Location Brazil
commented
Assigned: Unassigned » elber

I will work on it.

anoopsingh92’s picture

anoopsingh92
Location Rajasthan, India
commented
Status: Needs work » Needs review
StatusFileSize
new 3312696-16.patch2.78 KB

Please review this patch. Fixed some grammatical errors and warnings. Fixed the 

phpcs

issues also from this file.

Before:

Lenovo@LAPTOP-PDE747K8 MINGW64 /c/xampp/htdocs/drupal-9/web/modules/contrib/baguettebox-3312696 (3312696-make--module)
$ phpcs --standard=Drupal,DrupalPractice --extensions=php,module,inc,install,test,profile,theme,css,info,txt,md,yml,twig README.txt

FILE: C:\xampp\htdocs\drupal-9\web\modules\contrib\baguettebox-3312696\README.txt
---------------------------------------------------------------------------------
FOUND 0 ERRORS AND 4 WARNINGS AFFECTING 4 LINES
---------------------------------------------------------------------------------
 32 | WARNING | Line exceeds 80 characters; contains 83 characters
 57 | WARNING | Line exceeds 80 characters; contains 83 characters
 73 | WARNING | Line exceeds 80 characters; contains 82 characters
 79 | WARNING | Line exceeds 80 characters; contains 84 characters
---------------------------------------------------------------------------------

Time: 160ms; Memory: 8MB

After: 

Lenovo@LAPTOP-PDE747K8 MINGW64 /c/xampp/htdocs/drupal-9/web/modules/contrib/baguettebox-3312696 (3312696-make--module)
$gphpcs --standard=Drupal,DrupalPractice --extensions=php,module,inc,install,test,profile,theme,css,info,txt,md,yml,twig README.txt

Lenovo@LAPTOP-PDE747K8 MINGW64 /c/xampp/htdocs/drupal-9/web/modules/contrib/baguettebox-3312696 (3312696-make--module)
$
elber’s picture

elber
Primary language Portuguese, Brazil
Location Brazil
commented
Assigned: elber » Unassigned
StatusFileSize
new 3312696-17.patch3.18 KB

Hi @anoopsingh92 I couldn't to apply your patch and then I did a new patch to fix some phpcs erros e others small things. Please revise!

LeoAlcci’s picture

LeoAlcci commented
Assigned: Unassigned » LeoAlcci

I will review it!

LeoAlcci’s picture

LeoAlcci commented
Assigned: LeoAlcci » Unassigned
StatusFileSize
new 3312696-19.patch3.18 KB

I fixed all grammatical issues. It was only the 's' on depends. I think this is in a good state. Please kindly review it!

juancec’s picture

juancec commented
Assigned: Unassigned » juancec

I'll review it.

juancec’s picture

juancec commented
Assigned: juancec » Unassigned
Status: Needs review » Reviewed & tested by the community

Hey, good work everyone, indeed the grammatical issues have been fixed. Moving it to RTBC.

avpaderno’s picture

avpaderno
he/him
Primary language Italian
Location Brescia, 🇮🇹 🇪🇺
commented
Status: Reviewed & tested by the community » Needs work 
+Â * Download BaguetteBox library from https://github.com/feimosi/baguetteBox.js
+Â  Â Use the exact same version as defined in the baguettebox.libraries.yml file
+Â * Unzip the library and place files in the libraries directory.

It should change the text as it was done some lines over those.

+Â * Download the BaguetteBox library from
+   https://github.com/feimosi/baguetteBox.js.
+Â  Â Use the exact same version as defined in the baguettebox.libraries.yml file
+Â * Unzip the library and place files in the libraries directory.
anchal_gupta’s picture

anchal_gupta commented
StatusFileSize
new 3312696-23.patch3.18 KB
new interdiff-3312696-17_23.txt535 bytes

I have uploaded the patch addressed #22

avpaderno’s picture

avpaderno
he/him
Primary language Italian
Location Brescia, 🇮🇹 🇪🇺
commented 
+Â * Download the BaguetteBox library from https://github.com/feimosi/baguetteBox.js.

That line is longer than 80 characters.

Anonymous’s picture

Anonymous (not verified) commented
StatusFileSize
new 3312696-25.patch1.12 KB
elber’s picture

elber
Primary language Portuguese, Brazil
Location Brazil
commented

Hi @anujasurve thanks for your work but your patch is incomplete and with some coding standards errors.

lbonfioli’s picture

lbonfioli commented

@apaderno, I didn't understand your comment, once the text is already in the format you suggested. The final work patch, on comment #19 indeed fixes all phpcs errors.

elber’s picture

elber
Primary language Portuguese, Brazil
Location Brazil
commented
Status: Needs work » Reviewed & tested by the community

Hi @apaderno thank you for your comment but I couldn't to understand it, and the patch #19 is good for me. Moving to RTBC.

avpaderno’s picture

avpaderno
he/him
Primary language Italian
Location Brescia, 🇮🇹 🇪🇺
commented
Status: Reviewed & tested by the community » Needs work

Lines should not be longer than 80 characters. That's what the coding standards about the README file says.

LeoAlcci’s picture

LeoAlcci commented
Status: Needs work » Reviewed & tested by the community

Moving to RTBC, please check the patch #19. I already check it twice, and there isn't any phpcs error in that specific patch.
Command use ->
phpcs --standard=Drupal,DrupalPractice --extensions=php,module,inc,install,profile,theme,css,info,txt,md,yml,yaml,feature,json,ts,tsx,feature,twig

  • f7e0704 committed on 8.x-1.x 
    Issue #3312696 by LeoAlcci, anoopsingh92, elber, lbonfioli, erikaagp:...
elber’s picture

elber
Primary language Portuguese, Brazil
Location Brazil
commented
Status: Reviewed & tested by the community » Fixed

Thank you everyone!

Status: Fixed » Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.

elber closed merge request !4