Week2 Blogpost #800

JoaoDell · 2023-06-14T19:02:38Z

Here is my week 2 blogpost everyone, let me know of any changes needed

ganimtron-10

Hey @JoaoDell ,
The blogpost was sucessfully generated locally but as you can see below the code section is not properly rendered as code. Secondly the image is also not loaded.
Please look into these issues otherwise it lgtm.

ganimtron-10 · 2023-06-15T13:59:32Z

docs/source/posts/2023/2023-06-12-week-2-joaodellagli.rst

@@ -0,0 +1,80 @@
+Week 2: The Importance of (good) Documentation
+=====================


The = symbol should cover the whole title.

JoaoDell · 2023-06-15T14:40:57Z

Thanks @ganimtron-10, do you know how can I properly render it as code? This has been a struggle. I will see what is up with the image as it is loading when I build it here, does github have anything related to privacy on images or something? I checked and my repo is public

JoaoDell · 2023-06-15T14:54:48Z

okay actually I forgot about the "::" usage will change that now 😵‍💫

JoaoDell · 2023-06-15T15:12:31Z

Just updated with the code properly rendered. However, I am still trying to figure out the problem with the image. What I done was to upload it to a personal repo named gsoc_assets and get the image link by "Open image in another page". It seems my link is different of yours previous uploaded images as they are on user-images, how do you proceed with using images in rst @ganimtron-10?

tvcastillod

@JoaoDell Nice blogpost. Looks good overall, just check one comment below.

tvcastillod · 2023-06-15T17:46:21Z

docs/source/posts/2023/2023-06-12-week-2-joaodellagli.rst

+
+
+
+.. image:: https://github.com/JoaoDell/gsoc_assets/main/images/allocate-2d-3d.png


I can see the image well

same, it works!

tvcastillod · 2023-06-15T17:53:45Z

docs/source/posts/2023/2023-06-12-week-2-joaodellagli.rst

+   }
+
+This slight difference is significant: while in Allocate2D the program immediately fails, in Allocate3D the function is simply returned
+**false**, with its error pushed to vtkErrorMacro. I could have realised that earlier if I were using vtkErrorMacro, but this contrastant


contrastant sounds weird to me, maybe you can use another word.

ganimtron-10 · 2023-06-16T02:10:27Z

It seems my link is different of yours previous uploaded images as they are on user-images, how do you proceed with using images in rst @ganimtron-10?

The approach you are using for adding image is more better and will work as a permanent solution, whereas the user-images are not under our control and may get deleted.
Still if you want to know how I did it last time, you may have noticed that I had a PR #790 where I had added the images in the description I got link of those images and added them into my post.
Otherwise when ever you paste an image in any issue body or PR body you get a user-image link that too works.

skoudoro

Nice blog post @JoaoDell !

See below my comments

skoudoro · 2023-06-16T14:17:26Z

docs/source/posts/2023/2023-06-12-week-2-joaodellagli.rst

+-----------------------
+
+Last week, I was facing some issues with a VTK feature essential so I could move forward with my project: Framebuffer Objects. 
+As described in my `last blogpost <https://blogs.python-gsoc.org/en/joaodellaglis-blog/the-fbo-saga-week-1/>`_, for some reason the 2D allocation methods for it weren't working.


it would be better to do a local reference. In rst, you can do a reference to another file and link will appears during the build.

Internal link have a higher priority than external link.

skoudoro · 2023-06-16T14:20:31Z

docs/source/posts/2023/2023-06-12-week-2-joaodellagli.rst

+This slight difference is significant: while in Allocate2D the program immediately fails, in Allocate3D the function is simply returned
+**false**, with its error pushed to vtkErrorMacro. I could have realised that earlier if I were using vtkErrorMacro, but this difference in their
+implementation made it harder for me and my mentors to realise what was happening.


nice catch! interesting

skoudoro · 2023-06-16T14:21:58Z

docs/source/posts/2023/2023-06-12-week-2-joaodellagli.rst

+     return false;
+   }
+
+This slight difference is significant: while in Allocate2D the program immediately fails, in Allocate3D the function is simply returned


Allocate2D
Allocate3D

mark them everywhere like you did for assert(this->Context);

skoudoro · 2023-06-16T14:22:02Z

docs/source/posts/2023/2023-06-12-week-2-joaodellagli.rst

+
+
+
+While in Allocate2D there is an ``assert(this->Context);``, in Allocate3D the assertion is translated into:


Allocate2D
Allocate3D

mark them everywhere like you did for assert(this->Context);

skoudoro · 2023-06-16T14:23:05Z

docs/source/posts/2023/2023-06-12-week-2-joaodellagli.rst

+
+
+
+.. image:: https://github.com/JoaoDell/gsoc_assets/main/images/allocate-2d-3d.png


same, it works!

skoudoro · 2023-06-16T14:23:22Z

docs/source/posts/2023/2023-06-12-week-2-joaodellagli.rst

+   color_texture.SetMinificationFilter(0) 
+   color_texture.SetMagnificationFilter(0) 
+
+The code worked fine. But as my last blogpost showed, Allocate3D() method worked just fine without a (visible) problem, why is that? 


Allocate2D
Allocate3D

mark them everywhere like you did for assert(this->Context);

JoaoDell · 2023-06-16T16:48:38Z

Hey @skoudoro I just made the changes you recommended. Is the way I changed the link the way you desired?

skoudoro · 2023-06-16T16:59:40Z

This might answer your question concerning link : https://stackoverflow.com/questions/37553750/how-can-i-link-reference-another-rest-file-in-the-documentation

currently, your change is incorrect concerning the link

codecov · 2023-06-16T17:59:08Z

Codecov Report

Merging #800 (a053fe0) into master (4160b1d) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master     #800   +/-   ##
=======================================
  Coverage   84.32%   84.32%           
=======================================
  Files          43       43           
  Lines       10173    10173           
  Branches     1383     1383           
=======================================
  Hits         8578     8578           
  Misses       1239     1239           
  Partials      356      356

JoaoDell · 2023-06-16T23:47:36Z

I guess it may work now @skoudoro, i have built it locally with the instructions the documentation had about linking and it worked, see if it works for you. Thanks for the tip 👍

skoudoro

Looks great! thanks for the update, merging

JoaoDell added 3 commits June 13, 2023 10:59

Week 2 Blogpost

b5bc9b8

Updating branch with master's latest changes

29f96c2

Added week 2

f52eaab

JoaoDell requested review from tvcastillod and ganimtron-10 June 14, 2023 19:03

JoaoDell added the type:Documentation label Jun 14, 2023

Fixed spell issues

d896a39

ganimtron-10 suggested changes Jun 15, 2023

View reviewed changes

Code properly rendered

f13a51d

tvcastillod reviewed Jun 15, 2023

View reviewed changes

Minor correction

6e3d9d2

skoudoro reviewed Jun 16, 2023

View reviewed changes

Link and other fixes

35a1799

JoaoDell added 2 commits June 16, 2023 20:43

Linking changes

7d5039a

Updating branch with master's latest changes

a053fe0

skoudoro approved these changes Jun 19, 2023

View reviewed changes

skoudoro merged commit 224c52a into fury-gl:master Jun 19, 2023
22 of 30 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Week2 Blogpost #800

Week2 Blogpost #800

JoaoDell commented Jun 14, 2023

ganimtron-10 left a comment

ganimtron-10 Jun 15, 2023

JoaoDell commented Jun 15, 2023

JoaoDell commented Jun 15, 2023

JoaoDell commented Jun 15, 2023

tvcastillod left a comment

tvcastillod Jun 15, 2023

skoudoro Jun 16, 2023

tvcastillod Jun 15, 2023

ganimtron-10 commented Jun 16, 2023

skoudoro left a comment

skoudoro Jun 16, 2023

skoudoro Jun 16, 2023

skoudoro Jun 16, 2023

skoudoro Jun 16, 2023

skoudoro Jun 16, 2023

skoudoro Jun 16, 2023

JoaoDell commented Jun 16, 2023

skoudoro commented Jun 16, 2023

codecov bot commented Jun 16, 2023 •

edited

Loading

JoaoDell commented Jun 16, 2023

skoudoro left a comment

		@@ -0,0 +1,80 @@
		Week 2: The Importance of (good) Documentation
		=====================




		.. image:: https://github.com/JoaoDell/gsoc_assets/main/images/allocate-2d-3d.png




		While in Allocate2D there is an ``assert(this->Context);``, in Allocate3D the assertion is translated into:

Week2 Blogpost #800

Week2 Blogpost #800

Conversation

JoaoDell commented Jun 14, 2023

ganimtron-10 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

JoaoDell commented Jun 15, 2023

JoaoDell commented Jun 15, 2023

JoaoDell commented Jun 15, 2023

tvcastillod left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ganimtron-10 commented Jun 16, 2023

skoudoro left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

JoaoDell commented Jun 16, 2023

skoudoro commented Jun 16, 2023

codecov bot commented Jun 16, 2023 • edited Loading

Codecov Report

JoaoDell commented Jun 16, 2023

skoudoro left a comment

Choose a reason for hiding this comment

codecov bot commented Jun 16, 2023 •

edited

Loading