Generally, people shouldn't 'merge' anything from git repository. please rebase your work onto upstream/master. Otherwise cherry-picking your commit will work too.

Generally, people shouldn't 'merge' anything from git repository. please rebase your work onto upstream/master. Otherwise cherry-picking your commit will work too.

i'm not too familiar with cherrypicking, i will try the rebase route

@AthulMuralidhar how are you testing your PRs?

@AthulMuralidhar how are you testing your PRs?

just by the testing doc in the dev guide, i also run fmt and clippy

I also try to run the interpreter prompt from runpython and check the __doc__ there

@AthulMuralidhar how are you testing your PRs?

just by the testing doc in the dev guide, i also run fmt and clippy

Try actually compiling and running the RustPython executable. When the primary shows up, type help(bytearray()).

We write the code to build a real product, not just writing codes for codes themselves. Understanding how your code change affect the product is important for contributions. If you don't understand how your contribution affect products, please investigate about it first. This comment is also about your other PR too.

Firstly, thanks guys for your inputs. I admit that I do not understand the project completely yet, but I will do my best and I assure you that as I work with the project more, I will be able to see the various parts of the project and how they work together. If you guys think that my contributions are not upto the mark, please feel free to reject the pr's - maybe also leaving some comments there so that i can learn and improve. Thanks again for letting me be a part of this project :)

question:
sometimes, i come across some pymethod deninitions like this:

    #[pymethod(name = "__radd__")]
    #[pymethod(magic)]

when i add the doc strings to the top of the code like so:

///  Return value+self.
  #[pymethod(name = "__radd__")]
  #[pymethod(magic)]
...

the output of the help method is the same for both __radd__ and __add__. I tried to add something like this:

///  Return value+self.
  #[pymethod(name = "__radd__")]
/// Return self+value.
  #[pymethod(magic)]
...

but now it just prints both the doc strings together, how can i get the radd doc string and add doc string to render separately? For now i have omitted the doc string all together. I will update it once i get some pointers from here :) thanks again

You caught good point. I have no idea whether we can fix it by fixing macro implementation or need to find another way. But they are ok for now. Let’s keep it like 3rd version for now. Thank you!

another question / help required: i just added the docs to the coroutine builtin, seems like the docs are not being genereated:
my local python build

 |  __del__(...)
 |  
 |  __getattribute__(self, name, /)
 |      Return getattr(self, name).
 |  
 |  __iter__(self, /)
 |      Implement iter(self).
 |  
 |  __next__(self, /)
 |      Implement next(self).
 |  
 |  __repr__(self, /)
 |      Return repr(self).
 |  
 |  close(...)
 |      close() -> raise GeneratorExit inside generator.
 |  
 |  send(...)
 |      send(arg) -> send 'arg' into generator,
 |      return next yielded value or raise StopIteration.
 |  
 |  throw(...)
 |      throw(typ[,val[,tb]]) -> raise exception in generator,
 |      return next yielded value or raise StopIteration.

help on coroutine from rustpython

 |  object()
 |  --
 |  
 |  The base class of the class hierarchy.
 |  
 |  When called, it accepts no arguments and returns a new featureless
 |  instance that has no instance attributes and cannot be given any.
 |  
 |  Methods defined here:
 |  
 |  __iter__(...)
 |  
 |  __next__(...)
 |  
 |  __repr__(...)
 |  
 |  close(...)
 |  
 |  send(...)
 |  
 |  throw(...)
 |  

please also notice that i have the exact same docs added in the file - seems like the doc generator is not picking it up. I will wait for your comments on this, while i move onto other builtins

the __reduce__ magic is also not rendered with the enumerate builtin

Hey @AthulMuralidhar. If you can, please pause on working on this for a bit since there's some ongoing work to try and automatically include these (see #3101).

Somewhat unfortunate that this conflicts with your current work but I'm sure there's going to be certain parts where some manual documentation will need to be added (from the top of my head, the __r*__ methods will need help).

maybe i can make a pr with the current changes already? or should i keep this one open you think? @DimitrisJim

I'd say wait a bit until the we get a clear picture of what can/cannot be covered automatically and then we can see how we can go forward with it.

A very late thanks for the PR but automating this to avoid copy pasting docstrings was the way to go 😄 I'll be closing this now but thanks again!